oddjob 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b952a30ef59eab2aecda48c84c792a02daff9e
-  data.tar.gz: 6d0f3456c227c1bef0888db3971a80671054ba1d
+  metadata.gz: 3b38a613bae0128e48baaf4e6df262e2fdf9a7a7
+  data.tar.gz: 4359f741c6bf217138c4094d4d57dc5bc5b6be0a
 SHA512:
-  metadata.gz: 71b6164c4462f00a4e7c6cb6385eec124b2d13aea477301ae205d4aac46ed288293ada192acc5499bfa106963ee2edca41e422da83bcd6f54dac620c55c09ef8
-  data.tar.gz: aab8882dd01c9585ec228f6a3ba481f9f746b0e906345bbef4fd7f3ae00817ce74fde44c3e9a38feffba4b58bcd8cc340934b26538165a138c3f4af582b8b68b
+  metadata.gz: 23a926175279b4e046611c9230aec7367a5f7e3df64672cf307028ff0fc3c1ff796669ac6980fc4e9521d178041d83b31da4b4c714140aac59a86e27be320fdc
+  data.tar.gz: 4a21400cce090e8e0cc762fdb58005e7d4514bfffa963bc31d41b38443d11a938a597266da0f3beea7ed3e8cfdbc19b34c9530d4b0e2ad821e27528b64f1c230

data/.gitignore

@@ -1,4 +1,5 @@
 *.swp
+*.gem
 .ruby-version
 .bundle
 vendor

data/README.md

@@ -1,5 +1,7 @@
 # oddjob #
 
+[![Gem Version](https://badge.fury.io/rb/oddjob.svg)](https://badge.fury.io/rb/oddjob)
+
 oddjob is a lightweight, command line controlled web server.  Built for
 development and testing purposes, it can be used to serve static content for
 local web development and has basic file upload capabilities.  It was initially
@@ -26,7 +28,7 @@ out of the included `bin` directory.
 ## Installation ##
 
 oddjob is available as a ruby gem.  To install it for general command line
-use simply use gem like so:
+use gem install:
 
 ```sh
 gem install oddjob
@@ -42,11 +44,16 @@ gem 'oddjob'
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 You can also run oddjob directly from the git repo.  Clone the git repo and run
-oddjob directly from the repo's bin directory.
+oddjob directly from the repo's bin directory.  For example:
+
+```sh
+git clone https://github.com/MCF/oddjob.git
+./oddjob/bin/oddjob
+```
 
 ## Usage ##
 
@@ -56,8 +63,8 @@ Command line usage is:
 oddjob [OPTIONS] [server_root]
 ```
 
-Where the optional server_root argument will be the server's root directory.
-The default server root is the current working directory.
+Where the optional server_root argument will be the served root directory.  The
+default server root is the current working directory.
 
 The default file upload behaviour will print the contents of the HTTP POST
 request, and the contents of any uploaded files, to the server's STDOUT.  It is
@@ -97,8 +104,8 @@ To stop oddjob use the normal interrupt key combination (usually Ctrl-C).
 oddjob
 ```
 
-Serves the files and directories in your current working directory at the
-`http://localhost:4400/` URL.  File upload is available at
+Serves the files and directories in your current working directory at
+`http://localhost:4400/`.  File upload is available at
 `http://localhost:4400/oj_upload`
 
 ```sh
@@ -113,7 +120,7 @@ Serves the contents of the `./my-site` directory at the
 ## Environment ##
 
 oddjob is written in ruby and its only required dependency is a standard ruby
-install.  oddjob makes use of the built in ruby's
+install.  oddjob makes use of ruby's built in
 [webrick](http://ruby-doc.org/stdlib-2.0.0/libdoc/webrick/rdoc/WEBrick.html)
 web server library.  No gems are required for running oddjob.  oddjob has been
 tested with ruby 1.8.7 and up.

data/bin/oddjob

@@ -28,15 +28,14 @@ begin
 rescue LoadError
 end
 
-begin
-  require 'oddjob'    # Installed as a gem.
-rescue LoadError
-  lib = File.expand_path('../lib', File.dirname( __FILE__))
+# Prefer the local repo's lib directory.
+lib = File.expand_path('../lib', File.dirname( __FILE__))
+if File.exist?(File.join(lib, 'oddjob.rb'))
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-  require 'oddjob'    # Simply run from the repo, no gems.
 end
 
+require 'oddjob'
+
 def show_version
   STDOUT.puts("Version: #{OddJob::VERSION}")
   exit

data/lib/oddjob.rb

@@ -20,6 +20,7 @@
 # DEALINGS IN THE SOFTWARE.
 #++
 
+require 'ostruct'
 require 'webrick'
 require 'oddjob/version'
 
@@ -103,10 +104,13 @@ module OddJob
         "  a {text-decoration:none; color:rgb(248,157,30)}",
         "  a:hover {color:rgb(239,131,0);}",
         "  .header {font-size:0.75em; float:right; margin-bottom: 2.0em;}",
+        "  .fineprint {font-size:0.85em;}",
+        "  li {margin-bottom:0.4em;}",
         "  </style>",
         "</head>",
         "<html><body>",
         "  <div class=\"header\">",
+        "    <em>v#{VERSION}</em>",
         "    <a href=\"https://github.com/MCF/oddjob\">OddJob on github</a>",
         "  </div>",
         "  <div style=\"clear:both;\"></div>",
@@ -145,7 +149,7 @@ module OddJob
     # Render the HTML for the informational page.
     def info_page
       html = [
-        "  <h1>#{File.basename($0)}</h1>",
+        "  <h2>#{File.basename($0)}</h2>",
         "  <p>Version: <strong>#{VERSION}</strong></p>"
       ]
       html << "  <pre>#{@usage}</pre>" unless @usage.nil?
@@ -162,7 +166,7 @@ module OddJob
 
     ##
     # Standard servlet initialization function with additional arguments.
-    # 
+    #
     # +delay+ is the seconds of simulated network delay to wait before
     # responding after an upload request.
     #
@@ -189,12 +193,12 @@ module OddJob
         puts "-- END File Upload POST Request --"
       end
 
-      all_files = Array.new
+      all_uploads = Array.new
       ['file', 'file[]'].each do |name|
         if request.query[name]
           request.query[name].each_data do |data|
-
-            all_files.push(data.filename)
+            upload = OpenStruct.new
+            upload.name = data.filename
 
             if @save_directory.nil? # File contents to server STDOUT.
               puts "== BEGIN #{data.filename} Contents =="
@@ -204,14 +208,17 @@ module OddJob
               output_name = unique_name(data.filename, @save_directory)
               File.open(output_name, "w"){|f| f.print(data.to_s)}
               puts "#{data.filename} uploaded, saved to #{output_name}"
+              upload.output_name = File.expand_path(output_name)
             end
+
+            all_uploads.push(upload)
           end
         end
       end
 
       response.status = 200
       response['Content-type'] = 'text/html'
-      response.body = uploaded_page(all_files)
+      response.body = uploaded_page(all_uploads)
 
       sleep(@simulated_delay)
     end
@@ -240,7 +247,7 @@ module OddJob
 
       final_base = full_base = File.join(save_directory, base)
       i = 1
-      while(File.exist?(final_base + ext))
+      while File.exist?(final_base + ext)
         final_base = "#{full_base}_#{i}"
         i += 1
       end
@@ -252,18 +259,42 @@ module OddJob
     # Returns a string holding the full HTML page with the file upload form.
     def uploader_page
       html = [
-        "<h1>Uploader</h1>",
+        "<h2>Oddjob File Uploader</h2>",
         "<form action='' method='POST' enctype='multipart/form-data'>",
-        "  <p>",
-        "    Select file(s) to upload:",
+        "    <label for='file'>Select one or more files to upload:</label>",
         "    <br><br>",
         "    <input type='file' name='file' multiple='true'>",
         "    <br><br>",
-        "    <input type='submit'>",
-        "  </p>",
+        "    <input type='submit' value='Upload'>",
         "</form>",
+        "<br>",
       ]
 
+      if @save_directory.nil?
+        html += [
+          "<p class=\"fineprint\">",
+          "Currently file uploads will <strong>not</strong> be saved, instead",
+          "their contents will be printed to oddjob's standard output.",
+          "In this configuration it is recommended that you only upload",
+          "text files.",
+          "</p>",
+          "<p class=\"fineprint\">",
+          "To upload any kind of file (binary or text) specify an output",
+          "directory where files will be saved instead.  To see how visit the",
+          "<a href=\"#{INFO_PATH}\">info page</a>.",
+          "</p>",
+        ]
+      else
+        html += [
+          "<p class=\"fineprint\">",
+          "Uploaded files will be saved in the",
+          "<strong>#{File.expand_path(@save_directory)}</strong> directory.",
+          "New files do not overwrite existing ones, instead they are given",
+          "a unique numbered suffix.",
+          "</p>",
+        ]
+      end
+
       page(html, "Uploader")
     end
 
@@ -272,12 +303,24 @@ module OddJob
     #
     # +names+ is an array of the uploaded file names.  These are names
     # as submitted.  Saved names may be different to avoid overwritting.
-    def uploaded_page(names)
+    def uploaded_page(uploads)
       html = [
-        "<h1>Results</h1>",
-        "<p>Uploaded:",
-        "  <strong>#{names.join("</strong>, <strong>")}</strong>",
-        "</p>",
+        "<h2>Results</h2>",
+        "<p>Uploaded:</p>",
+        "<ul>",
+      ]
+
+      uploads.each do |upload|
+        html += [
+          "<li>",
+          "<strong>#{upload.name}</strong>",
+          upload.output_name ? " - saved to: #{upload.output_name}" : "",
+          "</li>",
+        ]
+      end
+
+      html += [
+        "</ul>",
         "<p><a href=''>Return to upload page</a></p>",
       ]
 

data/lib/oddjob/version.rb

@@ -1,3 +1,3 @@
 module OddJob
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oddjob
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Mike Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler