iproto 0.1

data/LICENSE

@@ -0,0 +1,24 @@
+/* 
+ * Copyright (C) 2011 Mail.RU
+  *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */

data/README.md

@@ -0,0 +1,4 @@
+# About
+
+Wrapper for Mail.Ru simple network protocol IProto. Support 2 modes: block via Ruby's TCPSocket and non block via EventMachine with fiblers.
+Wrapper used in [Tarantool ruby client](http://github.com/mailru/tarantool-ruby) and private libs.

data/Rakefile

@@ -0,0 +1,131 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+
+task :default => :spec
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/iproto.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'iproto'
+  s.version           = '0.1'
+  s.date              = '2012-01-23'
+  s.rubyforge_project = 'iproto'
+
+  s.summary     = "Mail.Ru simple network protocol"
+  s.description = "Mail.Ru simple network protocol"
+
+  s.authors  = ["Andrew Rudenko"]
+  s.email    = 'ceo@prepor.ru'
+  s.homepage = 'http://github.com/mailru/iproto-ruby'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  # = MANIFEST =
+  s.files = %w[
+    README.md
+    Rakefile
+    iproto.gemspec
+    lib/iproto.rb
+    lib/iproto/connection_api.rb
+    lib/iproto/em.rb
+    lib/iproto/tcp_socket.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+end

data/lib/iproto.rb

@@ -0,0 +1,24 @@
+module IProto
+  VERSION = '0.1'
+  class IProtoError < StandardError; end
+  class CouldNotConnect < IProtoError; end
+  class UnexpectedResponse < IProtoError; end
+
+  require 'iproto/connection_api'
+
+  # types:
+  # :em
+  # :block
+  def self.get_connection(host, port, type = :block)
+    case type
+    when :em
+      require 'iproto/em'
+      ::EM.connect host, port, IProto::EM::Connection
+    when :block
+      require 'iproto/tcp_socket'
+      IProto::TCPSocket.new(host, port)
+    else
+      raise "Undefined type #{type}"
+    end    
+  end
+end

data/lib/iproto/connection_api.rb

@@ -0,0 +1,12 @@
+module IProto
+  module ConnectionAPI
+    def next_request_id
+      @next_request_id ||= 0
+      @next_request_id += 1
+      if @next_request_id > 0xffffffff
+        @next_request_id = 0
+      end
+      @next_request_id
+    end
+  end
+end

data/lib/iproto/em.rb

@@ -0,0 +1,117 @@
+require 'eventmachine'
+require 'fiber'
+module IProto
+  module EM
+    module FixedHeaderProtocol
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def header_size(size = nil)
+          if size
+            @_header_size = size
+          else
+            @_header_size
+          end
+        end
+      end
+
+      attr_accessor :header, :body
+
+      def receive_data(data)
+        @buffer ||= ''
+        offset = 0
+        while (chunk = data[offset, _needed_size - @buffer.size]).size > 0 || _needed_size == 0
+          @buffer += chunk
+          offset += chunk.size
+          if @buffer.size == _needed_size
+            case _state
+            when :receive_header
+              @_state = :receive_body
+              receive_header @buffer
+            when :receive_body
+              @_state = :receive_header
+              receive_body @buffer
+            end
+            @buffer = ''
+          end
+        end 
+      end
+
+      def receive_header(header)
+        # for override
+      end
+
+      def body_size
+        # for override
+      end
+
+      def receive_body(body)
+        # for override
+      end
+
+      def _needed_size
+        case _state
+        when :receive_header
+          self.class.header_size
+        when :receive_body
+          body_size
+        end
+      end
+
+      def _state
+        @_state ||= :receive_header
+      end
+    end
+
+  class Connection < ::EM::Connection
+    include IProto::ConnectionAPI
+    include FixedHeaderProtocol
+
+    header_size 12
+
+    def connection_completed
+      @connected = true
+    end
+
+    # begin FixedHeaderAndBody API
+    def body_size
+      @body_size
+    end
+
+    def receive_header(header)
+      @type, @body_size, @request_id = header.unpack('L3')
+    end
+
+    def receive_body(data)
+      fiber = waiting_requests.delete @request_id
+      raise IProto::UnexpectedResponse.new("For request id #{@request_id}") unless fiber
+      fiber.resume data
+    end
+    # end FixedHeaderAndBody API
+
+    # begin ConnectionAPI
+    def send_packet(request_id, data)
+      send_data data      
+      f = Fiber.current
+      waiting_requests[request_id] = f
+      Fiber.yield
+    end
+    # end
+
+    def waiting_requests
+      @waiting_requests ||= {}
+    end
+
+    def close_connection(*args)
+      super(*args)
+    end
+
+    def unbind
+      raise IProto::CouldNotConnect.new unless @connected
+    end
+  end
+
+  end
+end

data/lib/iproto/tcp_socket.rb

@@ -0,0 +1,27 @@
+require 'socket'
+module IProto
+
+  # TODO: timeouts
+  class TCPSocket < ::TCPSocket
+    include IProto::ConnectionAPI
+
+    # begin ConnectionAPI
+    def send_packet(request_id, data)
+      send data, 0
+      body_size = recv_header request_id
+      recv_body body_size
+    end
+    # end ConnectionAPI
+
+    def recv_header(request_id)
+      header = recv(12)
+      type, body_size, recv_request_id = header.unpack('L3')
+      raise UnexpectedResponse.new("Waiting response for request_id #{request_id}, but received for #{recv_request_id}") unless request_id == recv_request_id
+      body_size
+    end
+
+    def recv_body(body_size)
+      recv(body_size)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: iproto
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Rudenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-23 00:00:00.000000000Z
+dependencies: []
+description: Mail.Ru simple network protocol
+email: ceo@prepor.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- README.md
+- Rakefile
+- iproto.gemspec
+- lib/iproto.rb
+- lib/iproto/connection_api.rb
+- lib/iproto/em.rb
+- lib/iproto/tcp_socket.rb
+- LICENSE
+homepage: http://github.com/mailru/iproto-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: iproto
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 2
+summary: Mail.Ru simple network protocol
+test_files: []