harbour 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kris Leech
+
+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,44 @@
+# Harbour
+
+With harbour you can:
+
+* See if a port is open
+* Find the pid of the process listening on a port
+* Kill the process listening on a port
+
+Note: Only works on MacOS, GNU/Linux coming soon...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'harbour'
+
+## Usage
+
+    port = Harbour::Port.new(8080)
+    port.open? # => true
+    port.pid   # => 1282
+    port.term!
+    port.kill!
+
+### Terminating a process
+
+    port = Harbour::Port.new(8080)
+    port.term!(:timeout => 10, :try_kill => true)
+
+* `timeout` - the number of seconds to wait for the process to terminate before
+  raising an exception
+* `try_kill` - if a TERM signal fails before timeout then send a KILL signal
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Author
+
+Kris Leech / teamcoding.com

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,3 @@
+Add timeout to pid, since the port may be open but no pid from lsof. Doing this will also allow the sleep(2) to be removed from start_server! in specs.
+add a self.all_ports which lists all open ports, maybe returning Port objects.
+raise exceptions instead of returning nil

data/harbour.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'harbour/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "harbour"
+  gem.version       = Harbour::VERSION
+  gem.authors       = ["Kris Leech"]
+  gem.email         = ["kris.leech@interkonect.com"]
+  gem.description   = %q{Query and terminate processes listening on ports}
+  gem.summary       = %q{Query and terminate processes listening on ports}
+  gem.homepage      = "https://github.com/krisleech/harbour"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack'
+end

data/lib/harbour.rb

@@ -0,0 +1,45 @@
+require "harbour/version"
+
+module Harbour
+  class Port
+    attr_reader :port
+
+    def initialize(port)
+      @port = port
+    end
+
+    def open?
+      command "nc -z localhost #{port}"
+    end
+
+    def pid
+      return nil unless open?
+      `lsof -P | grep ':#{port}' | grep 'LISTEN' | awk '{print $2}'`
+    end
+
+    def term!(options = {})
+      return nil unless open?
+      command "kill #{pid}"
+      ensure_open(options[:timeout] || 10)
+    end
+
+    def kill!(options = {})
+      return nil unless open?
+      command "kill -9 #{pid}"
+      ensure_open(options[:timeout] || 10)
+    end
+
+    private
+
+    def ensure_open(within = 10)
+      within.times do
+        break if open?
+        sleep(1)
+      end
+    end
+
+    def command(_command)
+      system "#{_command} > /dev/null"
+    end
+  end
+end

data/lib/harbour/version.rb

@@ -0,0 +1,3 @@
+module Harbour
+  VERSION = "0.0.1"
+end

data/spec/port_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Harbour::Port do
+  let(:port) { 3000 }
+
+  it '#open? returns false if port is not open' do
+    Harbour::Port.new(8080).open?.should be_false
+  end
+
+  it '#open? returns true if port is open' do
+    with_server(port) do
+      Harbour::Port.new(3000).open?.should be_true
+    end
+  end
+
+  it '#pid returns process pid' do
+    with_server(port) do
+      Harbour::Port.new(port).pid.should_not be_nil
+    end
+  end
+
+  it '#term! terminates process listening on port' do
+    with_server(port) do
+      Harbour::Port.new(3000).term!
+      port_open?(port).should be_false
+    end
+  end
+
+  it '#kill! terminates process listening on port' do
+    with_server(port) do
+      Harbour::Port.new(3000).kill!
+      port_open?(port).should be_false
+    end
+  end
+end

data/spec/server/config.ru

@@ -0,0 +1,7 @@
+require 'rack'
+
+app = proc do |env|
+    [200, { 'Content-Type' => 'text/html' }, ['Hello world!']]
+end
+
+run app

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require "net/http"
+require "uri"
+require 'harbour'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+def with_server(port = '8000', &block)
+  start_server!(port)
+  yield
+  stop_server!(port)
+end
+
+def start_server!(port)
+  return if system "nc -z localhost #{port}"
+  server_root = File.join(File.dirname(__FILE__), 'server')
+  system "cd #{server_root} && rackup -d -p #{port} &"
+  sleep(2)
+end
+
+def stop_server!(port)
+  pid = `lsof -P | grep ':#{port}' | grep 'LISTEN' | awk '{print $2}'`
+  system "kill -9 #{pid}"
+end
+
+def port_open?(port)
+  uri = URI.parse("http://localhost:#{port}")
+  response = Net::HTTP.get_print(uri)
+  response.include? 'Hello'
+rescue
+  false
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: harbour
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Query and terminate processes listening on ports
+email:
+- kris.leech@interkonect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- harbour.gemspec
+- lib/harbour.rb
+- lib/harbour/version.rb
+- spec/port_spec.rb
+- spec/server/config.ru
+- spec/spec_helper.rb
+homepage: https://github.com/krisleech/harbour
+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.23
+signing_key: 
+specification_version: 3
+summary: Query and terminate processes listening on ports
+test_files:
+- spec/port_spec.rb
+- spec/server/config.ru
+- spec/spec_helper.rb