spidermech 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 637a38fca20a36c523b57ae807ffa30b1b9d63f3
-  data.tar.gz: 9b417e4ce15fea26b72127c4b4b6624f0ac85847
+  metadata.gz: 470adf10493e1607b18798221f1d43a83ddfb06b
+  data.tar.gz: b4fed7921f1a540c49f11c405fe3c404ece38978
 SHA512:
-  metadata.gz: 11c1e177153ab63db942a826ab877242997d9d22e2e8971cf87d391fc7969e00d82475f504724054c4722bbc981c8257150f4c75ba19d9bd59013b38f6bff6b3
-  data.tar.gz: fed4c3d45c6949e190239e435eab66aa74ae5c13e613be34a72edf3eb16d669bf495095d0804c7c07d4ed94470d5db2228cc7806c3e3dfcb1e89d12e43f8a58f
+  metadata.gz: fb6ffec034eeb8fb1e019dd53553aabfacb5a1bf5111d7d308fe340986ee39eb8ea7558046e634c017d3b91641702085ceb47cc6cd30861ecd2f5fe70ec579f5
+  data.tar.gz: 5c752359c2b958aacf2d3d39fdfca31e0224f816024f6360ca352c6f80a9d2ba7d8ed416fb5e607af19867de45eda7ace5af437af49ca42e59b730f218a1d8e9

data/README.md

@@ -1,12 +1,12 @@
-# Crawler
+# SpiderMech
 
-TODO: Write a gem description
+SpiderMech crawls a given domain, and reports on the pages linked to from given urls, and the assets that said page depends on.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'crawler'
+    gem 'spidermech'
 
 And then execute:
 
@@ -18,16 +18,34 @@ Or install it yourself as:
 
 ## Gem Usage
 
-TODO: Write usage instructions here
+	require 'spidermech'
+	spider = SpiderMech.new 'http://google.com'
+	spider.run # returns the sitemap hash
+	spider.save_json # saves the sitemap hash as google.com.json
 
 ## Command Line Usage
 
 The gem provides a command line tool. You can invoke it via
 
-	bundle exec crawl http://google.com
+	bundle exec spidermech http://google.com
 
 It will crawl the page and give you the appropriate output.
 
+## Sample Output
+
+	[{:url=>"http://localhost:8321", 
+		:assets=>
+			{:scripts=>["https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js", "http://getbootstrap.com/dist/js/bootstrap.min.js"],
+
+			:images=>[],
+
+			:css=>
+			["http://getbootstrap.com/dist/css/bootstrap.min.css", "http://getbootstrap.com/examples/starter-template/starter-template.css"]}, 
+
+			:links
+			=>["/", "/about.html", "/contact.html"]},
+    ]
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/crawler/fork )

data/lib/spidermech.rb

@@ -1,7 +1,6 @@
 require 'mechanize'
 require 'logger'
 require 'json'
-require 'pry'
 
 class SpiderMech
   attr_reader :queue

data/spidermech.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "spidermech"
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ["Caleb Albritton"]
   spec.email         = ["ithinkincode@gmail.com"]
   spec.summary       = "Single URL crawler."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spidermech
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Caleb Albritton