alovak-network 1.0.0

data/lib/network/connection.rb

@@ -0,0 +1,95 @@
+module Network
+  class Connection
+    attr_reader   :uri, :pem
+
+    attr_accessor :read_timeout, :open_timeout, :headers, 
+                  :verify_peer, :ca_file,
+                  :debugger_stream
+
+    READ_TIMEOUT = 60
+    OPEN_TIMEOUT = 30 
+    VERIFY_NONE  = OpenSSL::SSL::VERIFY_NONE
+    VERIFY_PEER  = OpenSSL::SSL::VERIFY_PEER
+
+    def initialize(uri)
+      @uri = URI.parse(uri)
+      @read_timeout = READ_TIMEOUT
+      @open_timeout = OPEN_TIMEOUT
+      @verify_peer  = false
+      @debugger_stream = nil
+      @headers = {}
+    end
+
+    def post(data)
+      begin
+        http.post(uri.path, data, post_headers(data))
+      rescue Timeout::Error, Errno::ETIMEDOUT, Timeout::ExitException
+        raise Error, "The connection to the remote server is timed out"
+      rescue EOFError
+        raise Error, "The connection to the remote server was dropped"
+      rescue Errno::ECONNRESET, Errno::ECONNABORTED
+        raise Error, "The remote server reset the connection"
+      rescue Errno::ECONNREFUSED
+        raise Error, "The connection was refused by the remote server"
+      end
+    end
+
+    def use_ssl?
+      @uri.scheme == "https"
+    end
+
+    def pem_file(file)
+      @pem = File.read(file)
+    end
+
+    private
+
+    def http
+      http = Net::HTTP.new(uri.host, uri.port)
+      configure_timeouts(http)
+      configure_debugging(http)
+
+      configure_ssl(http) if use_ssl?
+      http
+    end
+
+    def post_headers(data)
+      @headers['Content-Type']   ||= 'application/x-www-form-urlencoded'
+      @headers['Content-Length'] ||= data.size.to_s
+      @headers
+    end
+
+    def configure_ssl(http)
+      http.use_ssl     = true
+
+      if pem
+        http.cert = cert
+        http.key  = key
+      end
+
+      if verify_peer
+        http.verify_mode = VERIFY_PEER
+        http.ca_file     = ca_file
+      else
+        http.verify_mode = VERIFY_NONE
+      end
+    end
+
+    def configure_timeouts(http)
+      http.read_timeout = read_timeout
+      http.open_timeout = open_timeout
+    end
+
+    def configure_debugging(http)
+      http.set_debug_output(debugger_stream)
+    end
+
+    def key
+      OpenSSL::PKey::RSA.new(pem)
+    end
+
+    def cert
+      OpenSSL::X509::Certificate.new(pem)
+    end
+  end
+end

data/lib/network.rb

@@ -0,0 +1,12 @@
+require 'net/https'
+require 'network/connection'
+module Network
+  class Error < Exception
+  end
+
+  VERSION = '1.0.0'
+
+  def self.post(url, data)
+    Connection.new(url).post(data)
+  end
+end

data/test/network/test_connection.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+
+class TestConnection < Test::Unit::TestCase
+  def setup
+    @connection = Network::Connection.new("http://example.com/path")
+    @http = mock('http')
+  end
+
+  def test_network_exceptions
+    [ { :class => Timeout::Error,       :message => "The connection to the remote server is timed out" },
+      { :class => EOFError,             :message => "The connection to the remote server was dropped"},
+      { :class => Errno::ECONNRESET,    :message => "The remote server reset the connection"},
+      { :class => Errno::ECONNABORTED,  :message => "The remote server reset the connection"},
+      { :class => Errno::ECONNREFUSED,  :message => "The connection was refused by the remote server"},
+    ].each do |exception|
+      Net::HTTP.any_instance.expects(:request).raises exception[:class]
+      e = assert_raise Network::Error do
+        @connection.post("some data")
+      end
+      assert_equal exception[:message], e.message
+    end
+  end
+
+  def test_default_timeouts
+    assert_equal Network::Connection::READ_TIMEOUT, @connection.read_timeout
+    assert_equal Network::Connection::OPEN_TIMEOUT, @connection.open_timeout
+  end
+
+  def test_change_timeouts
+    @connection.read_timeout = 10
+    @connection.open_timeout = 20
+    assert_equal 10, @connection.read_timeout
+    assert_equal 20, @connection.open_timeout
+  end
+
+  def test_default_headers_for_post_request
+    Net::HTTP.any_instance.expects(:post).with("/path", "data", 
+                                               { 'Content-Type'   => 'application/x-www-form-urlencoded',
+                                                 'Content-Length' => '4' })
+    @connection.post("data")
+  end
+
+  def test_user_headers_are_not_overwrited_by_default_headers
+    excepted_headers = {
+      'Content-Type' => 'application/xml',
+      'Accept'       => 'text/plain'
+    }
+
+    Net::HTTP.any_instance.expects(:post).with("/path",
+                                               "data", 
+                                               excepted_headers.update('Content-Length' => '4'))
+
+    @connection.headers = excepted_headers
+    @connection.post("data")
+  end
+
+  def test_configure_ssl_if_scheme_is_https
+    assert Network::Connection.new("https://example.com").use_ssl?
+    assert !Network::Connection.new("http://example.com").use_ssl?
+  end
+
+  def test_default_debug
+    assert_equal nil, @connection.debugger_stream
+  end
+
+  def test_change_debug
+    @connection.debugger_stream = STDOUT
+    assert_equal STDOUT, @connection.debugger_stream
+  end
+
+  def test_default_ssl_verify_mode
+    assert_equal false, @connection.verify_peer
+  end
+
+  def test_ssl_verify_peer_mode
+    @connection.verify_peer = true
+    assert_equal true, @connection.verify_peer
+  end
+
+  def test_timeouts_configuration
+    @http.expects(:read_timeout=)
+    @http.expects(:open_timeout=)
+    @connection.send(:configure_timeouts, @http)
+  end
+
+  def test_debugging_configuration
+    @http.expects(:set_debug_output)
+    @connection.send(:configure_debugging, @http)
+  end
+
+  def test_ssl_configuration_without_server_certification_verification
+    @http.expects(:use_ssl=)
+    @http.expects(:verify_mode=).with(Network::Connection::VERIFY_NONE)
+    @http.expects(:ca_file=).never
+    
+    @connection.send(:configure_ssl, @http)
+  end
+
+  def test_ssl_configuration_with_server_certification_verification
+    @connection.verify_peer = true
+    @http.expects(:use_ssl=)
+    @http.expects(:verify_mode=).with(Network::Connection::VERIFY_PEER)
+    @http.expects(:ca_file=)
+    
+    @connection.send(:configure_ssl, @http)
+  end
+
+  def test_ssl_configuration_with_client_pem_file
+    @connection.pem_file('test/test.pem')
+    @http.expects(:use_ssl=)
+    @http.expects(:cert=)
+    @http.expects(:key=)
+    @http.expects(:verify_mode=).with(Network::Connection::VERIFY_NONE)
+ 
+    @connection.send(:configure_ssl, @http)
+  end
+end

data/test/network/test_network.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class TestNetwork < Test::Unit::TestCase
+  def test_make_post_through_connection
+    Network::Connection.any_instance.expects(:post)
+    Network.post('http://site.com/', "some data")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+require "mocha"
+require 'turn'
+
+require 'lib/network'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: alovak-network
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Pavel Gabriel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: turn
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+description: HTTP/HTTPS communication module based on ruby net/http, net/https modules
+email: alovak@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/network/connection.rb
+- lib/network.rb
+- test/network/test_connection.rb
+has_rdoc: false
+homepage: http://github.com/alovak/network/
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: HTTP/HTTPS communication module based on ruby net/http, net/https modules
+test_files: 
+- test/network/test_network.rb
+- test/test_helper.rb