http_scanner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ed1dbf8a0e517b5a1682938a33a0e84b55d54b9
-  data.tar.gz: 81fbd0b8543f53eb6c2e6d0da2a3af517b3a6e4d
+  metadata.gz: 38f278a58f0907cadd481b05f6c545b31654f93a
+  data.tar.gz: 49f94ff59b7cee79b67d3e80d6649ee5ffe96989
 SHA512:
-  metadata.gz: 8f22fd71e5e9d1ef5d4a2b3ac7376ef1ee8cc1e61ab81fd0fb878c014873e49dea8689fd421f39ec7e1dc9f7f043f9dd18f5e405a4ff84c8e54dc6728bcc1799
-  data.tar.gz: f8316edf7a0140da260f47d50591a70bb62af8e5492d49e6e2389ae7579ee627cdc7776834e3d59cde81c6a4a5194439bfde4e6019b2e6f36e0f5daca401c18d
+  metadata.gz: a6e233b1db9146e3c91f89600c88e3f8f12d25feff9a31192e48f994fb337e08d64a4b0bf41d7a966d80654365db62e99c21079bd99ab51cac0b27c0592329f7
+  data.tar.gz: 4f90bf51584b31a1c694ae12a1a291d99a0496b2cd3c0b1eed113a3cc166019ac470ed8f0f4d8ab9c9ad149cd4850647885ea48fd2b3435ee4b250b1fcf198a7

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile.lock

@@ -1,13 +1,16 @@
 PATH
   remote: .
   specs:
-    http_scanner (0.1.0)
+    http_scanner (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
     rake (10.4.2)
+    redcarpet (3.3.1)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -21,6 +24,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -29,4 +38,10 @@ DEPENDENCIES
   bundler (~> 1.9)
   http_scanner!
   rake (~> 10.0)
+  redcarpet (~> 3.3)
   rspec (~> 3.3)
+  simplecov (~> 0.11.2)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,8 +1,10 @@
 # HttpScanner
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/http_scanner`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/bsdavidson/http_scanner.svg?branch=master)](https://travis-ci.org/bsdavidson/http_scanner)
 
-TODO: Delete this and the text above, and describe your gem
+A small Ruby gem that will scan your local network for running HTTP services and return an array IP addresses.
+
+Documentation is [available on RubyDoc.info](http://www.rubydoc.info/github/bsdavidson/http_scanner/).
 
 ## Installation
 
@@ -22,7 +24,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'http_scanner'
+
+scanner = HttpScanner.new
+ip_addresses = scanner.scan('SomeText')   # Look for pages containing SomeText
+```
 
 ## Development
 
@@ -32,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/http_scanner/fork )
+1. Fork it ( https://github.com/bsdavidson/http_scanner/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`)

data/Rakefile

@@ -1 +1,17 @@
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  nil
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  nil
+end
+
+task default: :spec

data/http_scanner.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'simplecov', '~> 0.11.2'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.3'
   spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

data/lib/http_scanner.rb

@@ -1,26 +1,43 @@
-require 'pp'
-require 'socket'
 require 'ipaddr'
+require 'logger'
 require 'net/http'
+require 'socket'
 
 require 'http_scanner/version'
 
 class HttpScanner
+  attr_writer :logger
+
   def initialize
     @mutex = Mutex.new
-    @results = []
     @queue = Queue.new
-    @ip_range = current_ip_range
+    @results = []
+  end
+
+  def logger
+    @logger ||= Logger.new(STDERR).tap do |logger|
+      logger.progname = 'http_scanner'
+    end
   end
 
-  def scan(signature)
-    addresses = get_ip_range(@ip_range[:ip_start], @ip_range[:ip_end])
+  # Scans the local network and returns an array of IP addresses of systems that
+  # return text containing the signature.
+  #
+  # @param signature [String] Case sensitive string to be searched for in the
+  #   HTML of scanned systems.
+  # @param opts [Hash] Additional options.
+  # @option opts [Fixnum] :threads Size of the thread pool to use to scan the
+  #   local network. Defaults to 255 threads.
+  # @return [Array] IP addresses of systems with a positive match.
+  def scan(signature, opts = {})
+    ip_range = local_ip_range
+    addresses = get_ips_in_range(ip_range[:ip_start], ip_range[:ip_end])
     addresses.each do |address|
       @queue << address
     end
     threads = []
 
-    255.times do
+    (opts[:threads] || 255).times do
       threads << Thread.new do
         thread_results = scan_thread(@queue, signature)
         @mutex.synchronize do
@@ -33,7 +50,8 @@ class HttpScanner
       begin
         thread.join
       rescue => e
-        p "Thread Join Error: #{e}"
+        logger.error "Caught error in thread:"
+        logger.error e
       end
     end
     @results
@@ -41,23 +59,20 @@ class HttpScanner
 
   protected
 
-  def current_ip_range
+  def local_ip_range
     ip_local = local_ip
-    p '#####################################'
-    p '#                                   #'
-    p '#' + "YOUR IP: #{ip_local}".center(35) + '#'
-    p '#                                   #'
-    p '#####################################'
     ip = ip_local.split('.')
-    ip_start = "#{ip[0]}.#{ip[1]}.#{ip[2]}.0"
+    ip_start = "#{ip[0]}.#{ip[1]}.#{ip[2]}.1"
     ip_end = "#{ip[0]}.#{ip[1]}.#{ip[2]}.255"
+    logger.debug "Local IP address: #{ip_local}"
+    logger.debug "Local IP range: #{ip_start}...#{ip_end}"
     {
       ip_start: ip_start,
       ip_end: ip_end
     }
   end
 
-  def get_ip_range(start_ip, end_ip)
+  def get_ips_in_range(start_ip, end_ip)
     start_ip = IPAddr.new(start_ip)
     end_ip = IPAddr.new(end_ip)
     (start_ip..end_ip).map(&:to_s)
@@ -79,6 +94,7 @@ class HttpScanner
                         read_timeout: 2,
                         open_timeout: 2)
       rescue
+        logger.debug('#{addr}: connection error')
         nil
       end
       if http
@@ -91,14 +107,12 @@ class HttpScanner
           nil
         end
         if body.include?(signature)
-          print "!#{addr} "
+          logger.debug "#{addr}: string found"
           results << addr
         else
-          print '*'
+          logger.debug "#{addr}: string not found"
         end
         http.finish
-      else
-        print '.'
       end
     end
   rescue ThreadError

data/lib/http_scanner/version.rb

@@ -1,3 +1,3 @@
 class HttpScanner
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_scanner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Davidson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-18 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: 
 email:
 - bsdavidson@gmail.com
@@ -61,6 +103,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -92,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A small Ruby gem that will scan your local network for running HTTP services