simple_socket 0.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    simple_socket (0.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  simple_socket!

data/README.md

@@ -0,0 +1,20 @@
+
+# Simple Socket
+
+Simple Socket is a gem to allow you to more easily make use of TCP sockets. 
+
+### Installation
+
+    gem install simple_socket
+
+### Usage
+
+    => SimpleSocket.new('localhost', 12345).write("my_query") 
+    => "response_value_from_socket"
+
+
+SimpleSocket also supports specifying a timeout parameter when creating a new socket:
+
+    => SimpleSocket.new('localhost', 12345, 12)
+
+This will set the timeout to 12 seconds. The default timeout is 10 seconds.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |s|
+  s.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec

data/lib/simple_socket.rb

@@ -0,0 +1,27 @@
+require 'socket'
+require 'timeout'
+
+class SimpleSocket
+  attr_reader :host, :port, :timeout
+  DEFAULT_TIMEOUT = 10
+
+  def initialize(host, port, timeout = DEFAULT_TIMEOUT)
+    @host = host
+    @port = port
+    @timeout = timeout 
+  end
+
+  def write(message)
+    begin
+      socket = TCPSocket.new(host, port)
+      socket.puts(message)
+      response = nil
+      Timeout::timeout(timeout) do 
+        response = socket.read
+      end
+    ensure
+      socket.close if socket
+    end
+    response
+  end
+end

data/simple_socket.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "simple_socket"
+  s.version = "0.1.1"
+  s.authors = ["Cyrus Innovation LLC"]
+  s.email = ["pzimbelman@cyrusinnovation.com"]
+  s.homepage = "https://github.com/cyrusinnovation/simple_socket"
+  s.summary = %q{TCP socket wrapper in a Ruby gem}
+  s.description = %q{A gem designed to allow easier use of a TCP socket by providing proper handling of the socket, including timeout/error handling, closing the connection, etc.}
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+end

data/spec/simple_socket_spec.rb

@@ -0,0 +1,62 @@
+require_relative 'spec_helper'
+
+describe SimpleSocket do
+  let(:host) { "myhost" }
+  let(:port) { 1151 }
+
+  it "should create a simple socket with a default timeout" do
+    socket = SimpleSocket.new(host, port)
+    socket.host.should == host
+    socket.port.should == port
+    socket.timeout.should == SimpleSocket::DEFAULT_TIMEOUT
+  end
+
+  it "should allow specifying a timeout" do
+    socket = SimpleSocket.new(host, port, 3)
+    socket.timeout.should == 3
+  end
+
+  it "should create a TCP socket with the correct parameters" do
+    TCPSocket.should_receive(:new).with(host, port).and_return(a_stubbed_socket)
+    SimpleSocket.new(host, port).write("foobar")
+  end
+
+  it "should return the sockets response" do
+    with(a_stubbed_socket.that_returns("A response")) do 
+      socket = SimpleSocket.new(host, port)
+      socket.write("foo").should == "A response"
+    end 
+  end
+
+  it "should send the message passed in to the socket" do
+    with(a_stubbed_socket.that_expects_message_of("my message")) do 
+      SimpleSocket.new(host, port).write("my message")
+    end 
+  end
+
+  it "should close the socket" do
+    with(a_stubbed_socket.that_requires_closing) do 
+      SimpleSocket.new(host, port).write("foo")
+    end 
+  end
+
+  it "should wrap the socket read with a timeout" do
+    with(a_stubbed_socket) do
+      Timeout.should_receive(:timeout).with(SimpleSocket::DEFAULT_TIMEOUT) 
+      SimpleSocket.new(host, port).write("foo")
+    end 
+  end
+
+  it "should close the socket even if an exceptions is raised" do
+    with(a_stubbed_socket.that_requires_closing) do 
+      Timeout.stub(:timeout).and_raise(Timeout::Error)
+      lambda {SimpleSocket.new(host, port).write("foo")}.should raise_error
+    end 
+  end
+
+  it "should return correct error if no connection is made" do
+    expect {
+      SimpleSocket.new("foobar", 123).write("foo")
+    }.to raise_error(SocketError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require_relative '../lib/simple_socket'
+
+module MockHelpers
+  def that_returns(response)
+    self.should_receive(:read).and_return(response)
+    self
+  end
+
+  def that_expects_message_of(message)
+    self.should_receive(:puts).with(message)
+    self
+  end
+
+  def that_requires_closing
+    self.should_receive(:close)
+    self
+  end
+end
+
+def a_stubbed_socket
+  double("tcpsocket").tap do |s|
+    s.stub(:puts)
+    s.stub(:read)
+    s.stub(:close)
+  end.extend(MockHelpers)
+end
+
+def with(socket)
+  TCPSocket.stub(:new => socket)
+  yield
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: simple_socket
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Cyrus Innovation LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70319314834420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319314834420
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70319314833980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319314833980
+description: A gem designed to allow easier use of a TCP socket by providing proper
+  handling of the socket, including timeout/error handling, closing the connection,
+  etc.
+email:
+- pzimbelman@cyrusinnovation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/simple_socket.rb
+- simple_socket.gemspec
+- spec/simple_socket_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cyrusinnovation/simple_socket
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: TCP socket wrapper in a Ruby gem
+test_files:
+- spec/simple_socket_spec.rb
+- spec/spec_helper.rb