rncp 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+--exclude .*_cmd.rb --exclude rncp.rb --no-private --protected lib/**/*.rb - README.md CHANGELOG

data/CHANGELOG

@@ -0,0 +1,6 @@
+0.0.2
+  - Added support for UDP Broadcast
+  - Added documentation
+
+0.0.1
+  - Initial release

data/README.md

@@ -0,0 +1,48 @@
+rncp / Ruby Network Copy
+====
+
+This project is a port of Pyncp which is a port of the original 
+"ncp - a fast file copy tool for LANs" originally written by Felix von
+Leitner <felix-ncp@fefe.de>
+
+At the moment rncp seems to be compatible with pyncp's default settings
+(i.e. Multicast for poll/push and gzip compression) but all options 
+will eventually be implemented via command line arguments. Also, all
+code should be pure ruby (minitar and Glib gems) so it should work with
+most if not all OS's.
+
+Installation
+------------
+
+Install ruby, then install the gem:
+
+    $ gem install rncp
+
+Its a pure ruby gem, depending on pure ruby gems, so it should work with 
+most rubies.
+
+Quick Start
+-----------
+
+If you want to send a file, directory or group of files/directories, start
+the listener on the destination machine:
+
+    $ rncp
+
+To send a file or directory directly:
+
+    $ rncp send 192.168.1.2 file.txt ./directory
+
+To send files and directories without knowing IP Addresses or Hostnames 
+setup a Multicast/Broadcast Poll on the destination machine:
+
+    $ rncp poll
+
+To send via Multicast/Broadcast use a push:
+
+    $ rncp push file.txt ./directory
+
+Credits
+-------
+Thanks to [Felix](http://www.fefe.de/ncp/) and
+[makefu](https://github.com/makefu/pyncp)

data/bin/rncp

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-
-require 'rncp'
-
-RNCP::Cli::CommandLineRunner.run
+#!/usr/bin/env ruby
+
+require 'rncp'
+
+RNCP::Cli::CommandLineRunner.run

data/lib/rncp.rb

@@ -1,39 +1,44 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/version'
-
-require 'clamp'
-
-require 'rncp/listen_cmd'
-require 'rncp/send_cmd'
-require 'rncp/poll_cmd'
-require 'rncp/push_cmd'
-
-module RNCP
-  def self.version_string
-    "RNCP version #{RNCP::VERSION}"
-  end
-
-  module Cli
-    class CommandLineRunner < Clamp::Command
-      self.default_subcommand = "listen"
-
-      subcommand 'listen', "runs in listener mode, waits for connection", ListenCommand
-      subcommand 'send', "sends files to a listener mode receiver", SendCommand
-      subcommand 'push', "broadcasts for clients, waits for connection", PushCommand
-      subcommand 'poll', "waits for broadcast, connects to broadcaster", PollCommand
-    end
-  end # Cli
-end
-
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/version'
+
+require 'clamp'
+
+require 'rncp/listen_cmd'
+require 'rncp/send_cmd'
+require 'rncp/poll_cmd'
+require 'rncp/push_cmd'
+
+module RNCP
+  def self.version_string
+    "rncp version #{RNCP::VERSION}"
+  end
+
+  module Cli
+    class CommandLineRunner < Clamp::Command
+      self.default_subcommand = "listen"
+
+      option ["--version", "-v"], :flag, "Show version" do
+        puts "rncp version #{RNCP::VERSION}"
+        exit(0)
+      end
+
+      subcommand 'listen', "runs in listener mode, waits for connection", ListenCommand
+      subcommand 'send', "sends files to a listener mode receiver", SendCommand
+      subcommand 'push', "broadcasts for clients, waits for connection", PushCommand
+      subcommand 'poll', "waits for broadcast, connects to broadcaster", PollCommand
+    end
+  end # Cli
+end
+

data/lib/rncp/files.rb

@@ -1,65 +1,78 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'zlib'
-require 'archive/tar/minitar'
-require 'stringio'
-
-module RNCP
-  module Files
-    def directory_list(path)
-      return [path].flatten if File.directory?(path) == false
-
-      data = []
-      Dir["#{path}**/*", "#{path}**/.*"].each do |entry|
-        next if entry[/^.*\/\.+$/]
-        data << directory_list(entry)
-      end
-      return data.flatten
-    end # directory_list
-
-    def tar(files)
-      data = StringIO.new("")
-      sgz = Zlib::GzipWriter.new(data)
-      tar = Archive::Tar::Minitar::Output.new sgz
-
-      puts "[#] start writing files"
-      files.each do |f|
-        directory_list(f).each do |entry|
-          puts "[*] adding: #{entry}"
-          Archive::Tar::Minitar.pack_file(entry, tar)
-        end
-      end
-
-      sgz.flush
-      sgz.close
-      sgz = nil
-
-      data.rewind
-      return data
-    end # tar
-
-    def untar(data)
-      sgz = Zlib::GzipReader.new(StringIO.new(data))
-      tar = Archive::Tar::Minitar::Input.new sgz
-
-      tar.each do |entry|
-        puts "[*] #{entry.name}"
-        tar.extract_entry "./", entry
-      end
-
-      sgz.close
-    end # untar
-
-  end # Files
-end # RNCP
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'zlib'
+require 'archive/tar/minitar'
+require 'stringio'
+
+module RNCP
+  # Module containing functions related to the file system and archive
+  # compression/decompression.
+  module Files
+    # Recursively creates a list of all items (files/directories) found
+    # in the path.
+    # @param path [String] path to starting directory or file
+    # @return [Array] flatten array of all contents of directory, or file
+    def directory_list(path)
+      return [path].flatten if File.directory?(path) == false
+
+      data = []
+      Dir["#{path}**/*", "#{path}**/.*"].each do |entry|
+        next if entry[/^.*\/\.+$/]
+        data << directory_list(entry)
+      end
+      return data.flatten
+    end # directory_list
+
+    # Creates a data string of a tar gzip file containing all files in
+    # list. See {#untar} for decompression.
+    # @param files [Arrray] list of files to add to archive
+    # return [StringIO] data bytes of tar gzip archive.
+    def tar(files)
+      data = StringIO.new("")
+      sgz = Zlib::GzipWriter.new(data)
+      tar = Archive::Tar::Minitar::Output.new sgz
+
+      puts "[#] start writing files"
+      files.each do |f|
+        directory_list(f).each do |entry|
+          puts "[*] adding: #{entry}"
+          Archive::Tar::Minitar.pack_file(entry, tar)
+        end
+      end
+
+      sgz.flush
+      sgz.close
+      sgz = nil
+
+      data.rewind
+      return data
+    end # tar
+
+    # Decompresses a data string of a tar gzip archive to current working
+    # directory. See {#tar} for compression.
+    # @param data [String] data bytes of tar gzip archive
+    def untar(data)
+      sgz = Zlib::GzipReader.new(StringIO.new(data))
+      tar = Archive::Tar::Minitar::Input.new sgz
+
+      tar.each do |entry|
+        puts "[*] #{entry.name}"
+        tar.extract_entry "./", entry
+      end
+
+      sgz.close
+    end # untar
+
+  end # Files
+end # RNCP

data/lib/rncp/listen_cmd.rb

@@ -1,26 +1,26 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/listener'
-
-module RNCP
-  module Cli
-    class ListenCommand < Clamp::Command
-
-      def execute
-        RNCP::NcpListener.new.listen
-      end
-
-    end # ListenCommand
-  end # Cli
-end # RNCP
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/listener'
+
+module RNCP
+  module Cli
+    class ListenCommand < Clamp::Command
+
+      def execute
+        RNCP::NcpListener.new.listen
+      end
+
+    end # ListenCommand
+  end # Cli
+end # RNCP

data/lib/rncp/listener.rb

@@ -1,84 +1,102 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/networking'
-require 'rncp/files'
-
-module RNCP
-  class NcpListener
-    include RNCP::Networking
-    include RNCP::Files
-
-    def initialize
-    end
-
-    def listen
-      puts "[#] rncp Listener: creating new connection"
-      l = bind_tcp
-      puts "[*] waiting for connections"      
-
-      sock, info = l.accept
-      printf "[*] connection from %s:%s\n", info.ip_address, info.ip_port
-      puts "[*] receiving..."
-
-      data = ""
-      while (sock.eof? == false)
-        data += sock.gets()
-      end
-
-      untar data
-      puts "[*] received: "
-
-      puts "[#] finished"
-      sock.close
-      l.close
-    end # listen
-
-    def poll
-      addr = nil
-      msock = join_multicast
-      puts "[*] waiting for something-cast"
-      loop do
-        begin
-          data, addr = msock.recvfrom 1024
-          if addr[1] == RNCP::PORT
-            puts "[*] found pusher at #{addr[3]}:#{addr[1]}"
-            puts "[#] Anouncement: #{data}"
-            break
-          else
-            puts "[?] received garbase from #{addr}"
-          end
-        rescue Execeptione => e
-          puts "exception #{e}"
-        end # begin
-      end #loop
-
-      msock.close if msock.nil? == false
-
-      sock = TCPSocket::new addr[3], addr[1]
-      sock.send "I am ready!", 0
-
-      data = ""
-      while (sock.eof? == false)
-        data += sock.gets()
-      end
-
-      untar data
-      puts "[*] received: "
-
-      puts "[#] finished"
-      sock.close
-    end # poll
-
-  end # NcpListener
-end # RNCP
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/networking'
+require 'rncp/files'
+
+module RNCP
+  # Class used to listen for direct and Multicast/Broadcast connections,
+  # which then triggers the receving of data from the Pusher class.
+  class NcpListener
+    include RNCP::Networking
+    include RNCP::Files
+
+    def initialize
+    end
+
+    # Listens for a direct connection from a source. Will wait until
+    # a connection is made and then decompresses files to current
+    # working directory.
+    def listen
+      puts "[#] rncp Listener: creating new connection"
+      l = bind_tcp
+      puts "[*] waiting for connections"      
+
+      sock, info = l.accept
+      printf "[*] connection from %s:%s\n", info.ip_address, info.ip_port
+      puts "[*] receiving..."
+
+      data = ""
+      while (sock.eof? == false)
+        data += sock.gets()
+      end
+
+      untar data
+      puts "[*] received: "
+
+      puts "[#] finished"
+      sock.close
+      l.close
+    end # listen
+
+    # Waits for a Multicast or Broadcast message sent by a source and
+    # establishes a connection similar to {#listen} which then
+    # decompresses files to current working directory.
+    def poll
+      addr = nil
+      msock = join_multicast
+      bsock = bind_broadcast
+      
+      if msock.nil? == true && bsock.nil? == true
+        puts "[!] cannot continue without atleast one announcement socket!"
+        return 1
+      end
+
+      xsock = msock.nil? == false ? msock : bsock
+
+      puts "[*] waiting for something-cast"
+      loop do
+        begin
+          data, addr = xsock.recvfrom 1024
+          if addr[1] == RNCP::PORT
+            puts "[*] found pusher at #{addr[3]}:#{addr[1]}"
+            puts "[#] Anouncement: #{data}"
+            break
+          else
+            puts "[?] received garbase from #{addr}"
+          end
+        rescue Exception => e
+          puts "exception #{e}"
+        end # begin
+      end #loop
+
+      msock.close if msock.nil? == false
+      bsock.close if bsock.nil? == false
+
+      sock = TCPSocket::new addr[3], addr[1]
+      sock.send "I am ready!", 0
+
+      data = ""
+      while (sock.eof? == false)
+        data += sock.gets()
+      end
+
+      untar data
+      puts "[*] received: "
+
+      puts "[#] finished"
+      sock.close
+    end # poll
+
+  end # NcpListener
+end # RNCP

data/lib/rncp/networking.rb

@@ -1,54 +1,91 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'socket'
-require 'ipaddr'
-require 'rncp/params'
-
-module RNCP
-  module Networking
-    def bind_tcp
-      sock = Socket::new Socket::AF_INET, Socket::SOCK_STREAM, 0
-      opts = [1].pack("i")
-      addr = [Socket::AF_INET, RNCP::PORT, 0, 0, 0, 0, 0, 0]
-        .pack("snCCCCNN")
-
-      sock.setsockopt Socket::SOL_SOCKET, Socket::SO_REUSEADDR, opts
-      sock.bind addr
-      sock.listen 1
-      return sock
-    end # bind_tcp
-
-    def join_multicast
-      msock = UDPSocket.new
-      membership = IPAddr.new(RNCP::IPV4_GROUP).hton +
-                   IPAddr.new("0.0.0.0").hton
-
-      puts "[#] Joining Multicast group"
-      msock.setsockopt :IPPROTO_IP, :IP_ADD_MEMBERSHIP, membership
-      msock.setsockopt :SOL_SOCKET, :SO_REUSEADDR, 1 
-      msock.bind "0.0.0.0", RNCP::PORT
-
-      return msock
-    end # join_multicast
-
-    def bind_multicast
-      msock = UDPSocket.open
-      msock.setsockopt :IPPROTO_IP, :IP_MULTICAST_TTL, [32].pack("i")
-      msock.setsockopt :SOL_SOCKET, :SO_REUSEADDR, 1 
-      msock.bind '', RNCP::PORT
-      msock.setsockopt :IPPROTO_IP, :IP_MULTICAST_LOOP, 1
-      return msock
-    end # bind_multicast
-  end # Networking
-end # RNCP
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'socket'
+require 'ipaddr'
+require 'rncp/params'
+
+module RNCP
+  # Contains common networking operations shared between listeners and 
+  # pushers.
+  module Networking
+    # Creates a TCP connection to listen for direct connections
+    # @return [Socket] listening socket
+    def bind_tcp
+      sock = Socket::new Socket::AF_INET, Socket::SOCK_STREAM, 0
+      opts = [1].pack("i")
+      addr = [Socket::AF_INET, RNCP::PORT, 0, 0, 0, 0, 0, 0]
+        .pack("snCCCCNN")
+
+      sock.setsockopt Socket::SOL_SOCKET, Socket::SO_REUSEADDR, opts
+      sock.bind addr
+      sock.listen 1
+      return sock
+    end # bind_tcp
+
+    # Creates a socket bound to the Multicast group. Returns nil if fails.
+    # This socket is used to listen for messages sent via Multicast. See
+    # {#bind_multicast} to send.
+    # @return [UDPSocket] multicast socket
+    def join_multicast
+      begin
+        msock = UDPSocket.new
+        membership = IPAddr.new(RNCP::IPV4_GROUP).hton +
+                     IPAddr.new("0.0.0.0").hton
+
+        puts "[#] Joining Multicast group"
+        msock.setsockopt :IPPROTO_IP, :IP_ADD_MEMBERSHIP, membership
+        msock.setsockopt :SOL_SOCKET, :SO_REUSEADDR, 1 
+        msock.bind "0.0.0.0", RNCP::PORT
+
+        return msock
+      rescue
+        puts "[!] Multicast not supported"
+        return nil
+      end
+    end # join_multicast
+
+    # Creates a socket that sends to Multicast group. Returns nil if fails.
+    # See {#join_multicast} to listen for Multicast.
+    # @return [UDPSocket] multicast socket
+    def bind_multicast
+      begin
+        msock = UDPSocket.open
+        msock.setsockopt :IPPROTO_IP, :IP_MULTICAST_TTL, [32].pack("i")
+        msock.setsockopt :SOL_SOCKET, :SO_REUSEADDR, 1 
+        msock.bind '', RNCP::PORT
+        msock.setsockopt :IPPROTO_IP, :IP_MULTICAST_LOOP, 1
+        return msock
+      rescue
+        puts "[!] Multicast not supported"
+        return nil
+      end
+    end # bind_multicast
+
+    # Creates a socket that sends and receives via Broadcast address.
+    # Returns nil if fails.
+    # @return [UDPSocket] broadcast socket
+    def bind_broadcast
+      begin
+        bsock = UDPSocket.open
+        bsock.setsockopt :SOL_SOCKET, :SO_BROADCAST, 1
+        bsock.setsockopt :SOL_SOCKET, :SO_REUSEADDR, 1
+        bsock.bind '', RNCP::PORT
+        return bsock
+      rescue
+        puts "[!] Broadcast not supported"
+        return nil
+      end
+    end # bind_broadcast
+  end # Networking
+end # RNCP

data/lib/rncp/params.rb

@@ -1,22 +1,31 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/version'
-
-module RNCP
-  IPV4_GROUP = '224.110.99.112'
-  IPV4_BC = '255.255.255.255'
-  PORT = 8002
-  MC_MSG = "Multicasting for rncp Version #{RNCP::VERSION}"
-  BC_MSG = "Broadcasting for rncp Version #{RNCP::VERSION}"
-end
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/version'
+
+module RNCP
+  # IPv4 Multicast Group
+  IPV4_GROUP = '224.110.99.112'
+
+  # IPv4 Broadcast Address
+  IPV4_BC = '255.255.255.255'
+
+  # ncp Server Port
+  PORT = 8002
+
+  # Message sent when connecting via multicast
+  MC_MSG = "Multicasting for rncp Version #{RNCP::VERSION}"
+
+  # Message sentw hen connecting via broadcast
+  BC_MSG = "Broadcasting for rncp Version #{RNCP::VERSION}"
+end

data/lib/rncp/poll_cmd.rb

@@ -1,27 +1,27 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/listener'
-
-module RNCP
-  module Cli
-    class PollCommand < Clamp::Command
-
-      def execute
-        RNCP::NcpListener.new.poll
-      end
-
-    end # PollCommand
-  end # Cli
-end # RNCP
-
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/listener'
+
+module RNCP
+  module Cli
+    class PollCommand < Clamp::Command
+
+      def execute
+        RNCP::NcpListener.new.poll
+      end
+
+    end # PollCommand
+  end # Cli
+end # RNCP
+

data/lib/rncp/push_cmd.rb

@@ -1,29 +1,29 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/pusher'
-
-module RNCP
-  module Cli
-    class PushCommand < Clamp::Command
-
-      parameter "FILE ...", "Files to send"
-
-      def execute
-        RNCP::NcpPusher.new.push file_list
-      end
-
-    end # PushCommand
-  end # Cli
-end # RNCP
-
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/pusher'
+
+module RNCP
+  module Cli
+    class PushCommand < Clamp::Command
+
+      parameter "FILE ...", "Files to send"
+
+      def execute
+        RNCP::NcpPusher.new.push file_list
+      end
+
+    end # PushCommand
+  end # Cli
+end # RNCP
+

data/lib/rncp/pusher.rb

@@ -1,109 +1,127 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/networking'
-require 'stringio'
-require 'fileutils'
-require 'zlib'
-require 'archive/tar/minitar'
-require 'tempfile'
-
-module RNCP
-  class NcpPusher
-    include RNCP::Networking
-    include RNCP::Files
-
-    def initialize
-    end
-
-    def send_to(ip, files)
-      begin
-        puts "[*] copying #{files} to ip : #{ip}"
-        sock = TCPSocket::new ip, RNCP::PORT
-        sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
-
-        data = tar files
-        
-        sock.send data.string, 0
-        sock.flush
-
-      rescue Exception => e
-        puts "[!] cannot create connection to host, bailing out"
-        puts e
-      ensure
-        sock.close if sock.nil? == false
-        puts "[#] finished"
-      end
-    end # send_to
-
-    def push(files)
-      begin
-        sock = nil
-        addr = nil
-        msock = bind_multicast
-
-        # check broadcast
-        
-        if msock.nil? == true
-          puts "[!] cannot continue without atleast one announcement socket!"
-          return 1
-        end
-
-        dsock = bind_tcp
-
-        if dsock.nil? == true
-          puts "[!] cannot continue without data socket"
-          return -1
-        end
-
-        puts "[*] starting X-Casting, waiting for TCP connect"
-        while sock.nil? == true
-          if msock.nil? == false
-            msock.send RNCP::MC_MSG, 0, RNCP::IPV4_GROUP, RNCP::PORT
-          end
-          # Broadcast
-          puts "."
-          result = select( [dsock], nil, nil, 2 )
-
-          next if result.nil? == true
-          for inp in result[0]
-            if inp == dsock
-              sock, addr = dsock.accept
-              printf "[*] connection from %s:%s\n",
-                  addr.ip_address, addr.ip_port
-              puts "[*] Client answer: #{sock.recv 1024}"
-            end # if
-          end # for inp
-        end # while sock.nil?
-
-        msock.close if msock.nil? == false
-        msock = nil
-        dsock.close if dsock.nil? == false
-        dsock = nil
-
-        data = tar files
-
-        sock.send data.string, 0
-        sock.flush
-      rescue Exception => e
-        puts "[!] cannot push data, bailing out"
-        puts e
-      ensure
-        sock.close if sock.nil? == false
-        puts "[*] finished"
-        msock.close if msock.nil? == false
-        dsock.close if dsock.nil? == false
-      end # begin
-    end # push
-  end # NcpPusher
-end # RNCP
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/networking'
+require 'stringio'
+require 'fileutils'
+require 'zlib'
+require 'archive/tar/minitar'
+require 'tempfile'
+
+module RNCP
+  # Class to establish a connection to a Listener class and then compress
+  # and send files.
+  class NcpPusher
+    include RNCP::Networking
+    include RNCP::Files
+
+    def initialize
+    end
+
+    # Sends file directly to a given IP Address or Hostname
+    # @param ip [String] the address or hostname of the destination
+    # @param files [Array] array of file/directory names to send
+    def send_to(ip, files)
+      begin
+        puts "[*] copying #{files} to ip : #{ip}"
+        sock = TCPSocket::new ip, RNCP::PORT
+        sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+
+        data = tar files
+        
+        sock.send data.string, 0
+        sock.flush
+
+      rescue Exception => e
+        puts "[!] cannot create connection to host, bailing out"
+        puts e
+      ensure
+        sock.close if sock.nil? == false
+        puts "[#] finished"
+      end
+    end # send_to
+
+    # Using Multicast or Broadcast, establishes a connection, compresses
+    # files and sends to destination.
+    # @param files [Array] array of file names to send
+    def push(files)
+      begin
+        sock = nil
+        addr = nil
+        msock = bind_multicast
+
+        # check broadcast
+        bsock = bind_broadcast
+        
+        if msock.nil? == true && bsock.nil? == true
+          puts "[!] cannot continue without atleast one announcement socket!"
+          return 1
+        end
+
+        dsock = bind_tcp
+
+        if dsock.nil? == true
+          puts "[!] cannot continue without data socket"
+          return -1
+        end
+
+        puts "[*] starting X-Casting, waiting for TCP connect"
+        while sock.nil? == true
+          # Multicast Ping
+          if msock.nil? == false
+            msock.send RNCP::MC_MSG, 0, RNCP::IPV4_GROUP, RNCP::PORT
+          end
+
+          # Broadcast Ping
+          if bsock.nil? == false
+            bsock.send RNCP::BC_MSG, 0, RNCP::IPV4_BC, RNCP::PORT
+          end
+
+          puts "."
+          result = select( [dsock], nil, nil, 2 )
+
+          next if result.nil? == true
+          for inp in result[0]
+            if inp == dsock
+              sock, addr = dsock.accept
+              printf "[*] connection from %s:%s\n",
+                  addr.ip_address, addr.ip_port
+              puts "[*] Client answer: #{sock.recv 1024}"
+            end # if
+          end # for inp
+        end # while sock.nil?
+
+        msock.close if msock.nil? == false
+        msock = nil
+        bsock.close if bsock.nil? == false
+        bsock = nil
+        dsock.close if dsock.nil? == false
+        dsock = nil
+
+        data = tar files
+
+        sock.send data.string, 0
+        sock.flush
+      rescue Exception => e
+        puts "[!] cannot push data, bailing out"
+        puts e
+      ensure
+        sock.close if sock.nil? == false
+        puts "[*] finished"
+        msock.close if msock.nil? == false
+        bsock.close if bsock.nil? == false
+        dsock.close if dsock.nil? == false
+      end # begin
+    end # push
+  end # NcpPusher
+end # RNCP

data/lib/rncp/send_cmd.rb

@@ -1,30 +1,30 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-require 'rncp/pusher'
-
-module RNCP
-  module Cli
-    class SendCommand < Clamp::Command
-
-      parameter "IP", "Destination IP Address"
-      parameter "FILE ...", "Files to send"
-
-      def execute
-        RNCP::NcpPusher.new.send_to ip, file_list
-      end
-
-    end # ListenCommand
-  end # Cli
-end # RNCP
-
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+require 'rncp/pusher'
+
+module RNCP
+  module Cli
+    class SendCommand < Clamp::Command
+
+      parameter "IP", "Destination IP Address"
+      parameter "FILE ...", "Files to send"
+
+      def execute
+        RNCP::NcpPusher.new.send_to ip, file_list
+      end
+
+    end # ListenCommand
+  end # Cli
+end # RNCP
+

data/lib/rncp/version.rb

@@ -1,17 +1,17 @@
-# RNCP - a fast file copy tool for LANs port in Ruby
-#
-# Copyright (c) 2013 Jeff Parent
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-
-module RNCP
-  VERSION = '0.0.1'
-end
+# RNCP - a fast file copy tool for LANs port in Ruby
+#
+# Copyright (c) 2013 Jeff Parent
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+module RNCP
+  VERSION = '0.0.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rncp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -43,7 +43,11 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.3'
-description: A port of NCP written in Ruby
+description: ! 'rncp provides a fast way of transfering files between systems.
+
+  Its pure Ruby port of Pyncp/Ncp.
+
+'
 email:
 - jecxjo@sdf.lonestar.org
 executables:
@@ -51,17 +55,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rncp.rb
-- lib/rncp/params.rb
-- lib/rncp/listener.rb
 - lib/rncp/files.rb
-- lib/rncp/pusher.rb
+- lib/rncp/listener.rb
 - lib/rncp/listen_cmd.rb
-- lib/rncp/poll_cmd.rb
-- lib/rncp/version.rb
-- lib/rncp/send_cmd.rb
 - lib/rncp/networking.rb
+- lib/rncp/params.rb
+- lib/rncp/poll_cmd.rb
+- lib/rncp/pusher.rb
 - lib/rncp/push_cmd.rb
+- lib/rncp/send_cmd.rb
+- lib/rncp/version.rb
+- lib/rncp.rb
+- .yardopts
+- README.md
+- CHANGELOG
 - bin/rncp
 homepage: http://github.com/jecxjo/rncp
 licenses: []
@@ -83,8 +90,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a fast file copy tool for LANs
 test_files: []
+has_rdoc: