xmlrpc-scgi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01932824af6cb128b102b0a984c5c4a2bd9637c4
+  data.tar.gz: 12462a5f89c3a5beab9e5ddc9de1cf79a0d656a1
+SHA512:
+  metadata.gz: 4b0cf638af945554445636afd32386fd82e622d703bdb1b0ca8eda345a64763771fb22c5c6335428be07b2ba6a18daa69313ac4dc043647abcae1a502db46d6f
+  data.tar.gz: 53bc728f0be1b82f5b39bf9745b54035069c8e9774b6a147f9522229d615a851051b1de44a30fbaaaebb2050fe0df3ea515444afde8f9921d317172a202a15b9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/MethodLength:
+  Max: 30
+AllCops:
+    Exclude:
+      - '**/Rakefile'
+      - '**/*.gemspec'
+              

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 kannibalox
+
+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,52 @@
+# XMLRPC::SCGI
+
+[![Build Status](https://travis-ci.org/smuth4/ruby-xmlrpc-scgi.svg)](https://travis-ci.org/smuth4/ruby-xmlrpc-scgi)
+
+A small gem to extend the XMLRPC module by adding an SCGI client and server. It also goes the extra mile and adds support for the non-standard `i8` tag.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xmlrpc-scgi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scgi-xmlrpc
+
+## Usage
+
+Server
+```ruby
+require 'xmlrpc/scgi'
+
+server = XMLRPC::SCGI.new '127.0.0.1:6000'
+server.add_handler('add') do |a, b|
+  a + b
+end
+
+# Runs until it is killed
+server.serve
+```
+
+Client
+```ruby
+require 'xmlrpc/scgi'
+
+client = XMLRPC::SCGIClient.new '127.0.0.1', '', 6000
+puts client.call('add', 4, 5)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scgi-xmlrpc/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,13 @@
+require 'bundler/gem_tasks'
+
+task default: %w(rubocop rspec)
+
+desc 'Run rubocop'
+task :rubocop do
+  sh 'rubocop'
+end
+
+desc 'Run RSpec'
+task :rspec do
+  sh 'bundle exec rspec spec'
+end

data/lib/xmlrpc/scgi.rb

@@ -0,0 +1,122 @@
+require 'pp'
+require 'xmlrpc/server'
+require 'xmlrpc/client'
+require 'xmlrpc/config'
+
+require 'xmlrpc/scgi/version'
+
+module XMLRPC
+  # A simple and naive server for serving XMLRPC over the SCGI protocol
+  class SCGIServer < XMLRPC::BasicServer
+    def initialize(socket, *a)
+      @socket = socket
+      super(*a)
+    end
+
+    def serve
+      if @socket.include? ':'
+        server = TCPServer.new(*@socket.split(':'))
+      else
+        server = UNIXServer.new(@socket)
+      end
+      loop do
+        begin
+          client = server.accept
+          _, body = split_request(client)
+          client.write write_http("\n#{process(body)}")
+        ensure
+          # no matter what we have to put this thread on the bad list
+          client.close unless client.nil? || client.closed?
+        end
+      end
+    end
+
+    def write_http(data)
+      content = [
+        'Status: 200 OK.',
+        'Content-Type: text/xml',
+        "Content-Length: #{data.length}",
+        data
+      ]
+      content.join "\n\r"
+    end
+
+    def read_netstring(handle)
+      len = handle.gets(':', 10).sub(':', '')
+      payload = handle.read(len.to_i)
+      if handle.read(1) == ','
+        payload
+      else
+        fail "Malformed request, does not end with ','"
+      end
+    end
+
+    def write_netstring(str)
+      "#{str.length}:#{str},"
+    end
+
+    def split_request(socket)
+      return if socket.closed?
+      payload = read_netstring socket
+      request = Hash[*(payload.split("\0"))]
+      fail 'Missing CONTENT_LENGTH' unless request['CONTENT_LENGTH']
+      length = request['CONTENT_LENGTH'].to_i
+      body = length > 0 ? socket.read(length) : ''
+      [request, body]
+    end
+  end
+
+  # A small derivative class for calling XMLRPC over SCGI
+  class SCGIClient < XMLRPC::Client
+    def do_rpc(xml, _ = false)
+      headers = {
+        'CONTENT_LENGTH' => xml.size,
+        'SCGI' => 1
+      }
+
+      header = "#{headers.to_a.flatten.join("\x00")}"
+      request = "#{header.size}:#{header},#{xml}"
+
+      TCPSocket.open(@host, @port) do |s|
+        s.write(request)
+        s.read.split(/\n\s*?\n/, 2)[1]
+      end
+    end
+  end
+end
+
+module XMLRPC
+  module XMLParser
+    # Overriding the default XML parser
+    class AbstractStreamParser
+      # A patch for the response method as rtorrent xmlrpc
+      # call returns some integers as i8 instead of i4 expected
+      # this results in int8 fields showing up with no data
+      # as the parse method is not capable of handling such
+      # a tag.
+
+      alias_method 'original_parseMethodResponse', 'parseMethodResponse'
+      def parseMethodResponse(str) # rubocop:disable Style/MethodName
+        str.gsub!(%r{<((\/)*)i8>}, '<\1i4>')
+        original_parseMethodResponse(str)
+      end
+    end
+  end
+end
+
+module XMLRPC
+  # Monkey patch the Create class
+  class Create
+    alias_method 'original_conv2value', 'conv2value'
+
+    def conv2value(param)
+      if ([Fixnum, Bignum].include? param.class) &&
+         (param <= -(2**31) || param >= (2**31 - 1))
+        cval = @writer.tag('i8', param.to_s)
+        @writer.ele('value', cval)
+      else
+        original_conv2value param
+      end
+    end
+  end
+end

data/lib/xmlrpc/scgi/version.rb

@@ -0,0 +1,6 @@
+module XMLRPC
+  # SCGI XMLRPC Component
+  module SCGI
+    VERSION = '0.0.1'
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,27 @@
+require 'xmlrpc/scgi'
+
+describe XMLRPC::SCGIClient do
+  before(:all) do
+    @server_thread = Thread.new do
+      server = XMLRPC::SCGIServer.new '127.0.0.1:6000'
+      server.add_handler('add') do |a, b|
+        a + b
+      end
+      server.serve
+    end
+    @client = XMLRPC::SCGIClient.new '127.0.0.1', '', 6000
+  end
+
+  after(:all) do
+    Thread.kill @server_thread
+    @server_thread.join
+  end
+
+  it 'should perform calls' do
+    expect(@client.call('add', 4, 5)).to be(4 + 5)
+  end
+
+  it 'should handle big ints calls' do
+    expect(@client.call('add', 2**(4 * 8), 5)).to be(2**(4 * 8) + 5)
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,67 @@
+require 'xmlrpc/scgi'
+
+describe XMLRPC::SCGIServer do
+  before(:each) do
+    @server = XMLRPC::SCGIServer.new 'fake socket'
+  end
+
+  context '.read_netstring' do
+    it 'Valid netstring' do
+      expect(@server.read_netstring(StringIO.new('5:hello,'))).to eql('hello')
+    end
+
+    it 'Invalid netstring - missing end comma' do
+      expect do
+        @server.read_netstring(StringIO.new('5:hello'))
+      end.to raise_error(RuntimeError)
+    end
+
+    it 'Invalid netstring - invalid length' do
+      expect do
+        @server.read_netstring(StringIO.new('53457254754754:hello,'))
+      end.to raise_error(RuntimeError)
+    end
+  end
+
+  it '.write_netstring' do
+    expect(@server.write_netstring('hello')).to eql('5:hello,')
+  end
+
+  context '.split_request' do
+    before(:each) do
+      @request = [
+        'CONTENT_LENGTH',
+        '56',
+        'SCGI',
+        '1',
+        'REQUEST_METHOD',
+        'POST',
+        'REQUEST_URI',
+        '/deepthought'
+      ]
+
+      @body = 'What is the answer to life, the Universe and everything?'
+    end
+
+    it 'Valid request' do
+      netstring = @server.write_netstring("#{@request.join("\0")}")
+      expect(@server.split_request(StringIO.new("#{netstring}#{@body}")))
+        .to eql([Hash[*@request], @body])
+    end
+
+    it 'Invalid request - short body' do
+      netstring = @server.write_netstring("#{@request[0..-3].join("\0")}")
+      expect(@server.split_request(StringIO.new("#{netstring}#{@body}")))
+        .to_not eql([Hash[*@request], @body])
+    end
+  end
+
+  it 'should spool up a server' do
+    server_thread = Thread.new do
+      server = XMLRPC::SCGIServer.new '127.0.0.1:6000'
+      server.serve
+    end
+    expect(server_thread.status).to be_a(String)
+    Thread.kill server_thread
+  end
+end

data/xmlrpc-scgi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmlrpc/scgi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xmlrpc-scgi"
+  spec.version       = XMLRPC::SCGI::VERSION
+  spec.authors       = ["Stephen Muth"]
+  spec.email         = ["smuth4@gmail.com"]
+  spec.summary       = %q{Extend XMLRPC with SCGI client and server.}
+  spec.description   = %q{Extend XMLRPC with SCGI client and 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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rubocop", "~> 0.35"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: xmlrpc-scgi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Muth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: Extend XMLRPC with SCGI client and server.
+email:
+- smuth4@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xmlrpc/scgi.rb
+- lib/xmlrpc/scgi/version.rb
+- spec/client_spec.rb
+- spec/server_spec.rb
+- xmlrpc-scgi.gemspec
+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: Extend XMLRPC with SCGI client and server.
+test_files:
+- spec/client_spec.rb
+- spec/server_spec.rb