statusz 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,13 +1,13 @@
 statusz
 =======
 
-statusz is a Ruby tool to write out git information when you deploy. It is useful if your project
-meets the following criteria:
+statusz is a Ruby tool to write out git information when you deploy. It is useful if your project meets the
+following criteria:
 
-* It lives in git (required)
-* It uses some kind of ruby-based deployment system (not strictly necessary, because you can call statusz via
-  the command-line if you want, but this still requires Ruby to run).
-* It is a web server that can serve up web pages (also not necessary; if this isn't the case, statusz can
+* It lives in git.
+* It's deployed using some kind of unix-y OS.
+* It uses some kind of ruby-based deployment system.
+* It is a web server that can serve up web pages (not strictly necessary; if this isn't the case, statusz can
   write out a plain text file for you instead).
 
 statusz helps you quickly tell what version of the code is actually running on your server, and who most
@@ -23,3 +23,53 @@ versions as well.
 
 Usage
 -----
+
+``` ruby
+# Somewhere in your deploy scripts, probably where you stage the files before you rsync them:
+require "statusz"
+Statusz.write_git_metadata("#{your_staging_root}/statusz.html")
+```
+
+Now you can serve up the file from your webserver however you like. If you have a public folder, you can drop
+the file in there. Here's how we serve it from one of our sinatra servers:
+
+``` ruby
+get "/statusz" do
+  statusz_file = File.join(settings.root, "statusz.html")
+  File.file?(statusz_file) ? send_file(statusz_file) : "No deploy data."
+end
+```
+
+If you want statusz to write a plain text file instead of an html file, you can do that:
+
+``` ruby
+Statusz.write_git_metadata("statusz.txt", :format => :text)
+```
+
+If you want statusz to only write some of the fields (skip `commit_search` to save space -- this field
+contains every sha in your repo, so it can be kind of large):
+
+``` ruby
+Statusz.write_git_metadata("statusz.html", :fields => ["latest_sha", "date", "username"])
+```
+
+Here are the possible fields -- by default, statusz will write them all:
+
+* `git_directory` -- The name of the directory at the git root
+* `latest_sha` -- The sha of the latest commit
+* `current_branch` -- The name of the branch, if any, from which the deploy is being run
+* `date` -- Timestamp
+* `username` -- The output of `whoami`
+* `git_user_info` -- The user name and email in git
+* `commit_search` -- A list of all commits. In the html version, it's a search box.
+
+Screenshot
+----------
+
+![screenshot](http://i.imgur.com/hjNvH.png)
+
+TODO
+----
+
+* Call via command-line script? Useful if doing a non-ruby deploy.
+* Other formats? (JSON?)

data/lib/statusz/version.rb

@@ -1,3 +1,3 @@
 module Statusz
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/statusz.rb

@@ -1,3 +1,4 @@
+require "cgi"
 require "erb"
 require "time"
 
@@ -50,7 +51,7 @@ module Statusz
         if field == "commit_search"
           pair = { FIELD_TO_HEADER_NAME[field] => FIELD_TO_SCRAPING_PROC[field].call.split("\n") }
         else
-          pair = { FIELD_TO_HEADER_NAME[field] => FIELD_TO_SCRAPING_PROC[field].call }
+          pair = { FIELD_TO_HEADER_NAME[field] => CGI.escapeHTML(FIELD_TO_SCRAPING_PROC[field].call) }
         end
         hash.merge pair
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statusz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md