haikulearning_mongrel_upload_progress 0.2.3 → 0.2.4

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.2.4. Changed the way UploadProgressConfig behaves. It now looks for a single mongrel_upload_progress.yml file with multiple environment configs set inside (much like database.yml in Rails). It also raises a NoConfigSpecified error if config there's a
+problem loading the relevant configuration.
+
 v0.2.3. Haiku Learning Systems modifications. The path_info Array now matches using === allowing for Regexp and other creative path matchers. Adding UploadProgressConfig to support different configurations for different environments.
 
 v0.2.2. Signed gem.

data/README.rdoc

@@ -5,3 +5,104 @@ A mongrel plugin that makes it possible to check the progress of in-transit uplo
 == Haiku Learning Systems Modifications
 
 This fork of the {original mongrel_upload_progress gem}[http://rubygems.org/gems/mongrel_upload_progress] has been modified by {Haiku Learning Systems}[http://www.haikulearning.com] to add a few features. Please read the CHANGELOG for more details about these changes.
+
+This plugin works as a *drop in replacement* for mongrel_upload_progress, though we *strongly suggest* you only have one or the other installed. We haven't tested the interaction between the two & make no guarantees that they will play well together.
+
+= Mongrel Configuration
+
+Place the following code somewhere in your code (e.g. <tt>config/mongrel_upload_progress.conf</tt>).
+
+  uri("/", 
+    :handler => plugin(
+      "/handlers/upload",
+      Mongrel::UploadProgressConfig.options(File.join(RAILS_ROOT, 'config'))
+    ),
+    :in_front => true
+  )
+
+Because, we're using Mongrel::UploadProgressConfig above, create a <tt>mongrel_upload_progress.yml</tt> file within the appropriate dir (within <tt>File.join(RAILS_ROOT, 'config')</tt> in the above example). The following
+is one example. Note: You'll need to specify a configuration for each environment
+you plan to use in your Application.
+
+  development: &_defaults
+    :path_info : 
+    - /upload/file                      # Handles UploadController#file
+    - !ruby/regexp /^\/file\/upload.*/  # Handles any upload* action in FileController
+    :debug : true
+  # Use the development settings, but override the :debug option.
+  production: 
+    <<: *_defaults
+    :debug : false
+
+Then reference the conf file when you start your mongrel(s)
+
+  mongrel_rails start -e development -S config/mongrel_upload_progress.conf
+
+= Using DRb
+
+A very useful feature if you're running more than one mongrel process, even across multiple servers.
+
+== DRb Configuration
+
+Update your <tt>mongrel_upload_progress.yml</tt> setting by adding DRb information.
+
+  production:
+    <<: *_defaults
+    :drb : druby://127.0.0.1:7999 # A single-server setup. Specify an IP or hostname other than loopback for multiple server setups.
+
+== DRb Server
+
+Now, start up a DRb server. Here's an example ruby script.
+
+  require 'rubygems'
+  require 'drb'
+  require 'gem_plugin'
+
+  RAILS_ENV = ENV['RAILS_ENV'] || 'development'
+  config_dir = File.join(File.dirname(__FILE__), '../config')
+
+  GemPlugin::Manager.instance.load 'mongrel' => GemPlugin::INCLUDE
+  DRb.start_service(
+    Mongrel::UploadProgressConfig.options(config_dir)[:drb],
+    Mongrel::UploadProgress.new
+  )
+  DRb.thread.join
+
+Start the above server with this command:
+
+  RAILS_ENV=production ruby path/to/above_script.rb &
+
+== DRb in IRB
+
+For debugging purposes, you can interact with your DRb server using the following IRB script
+
+  require 'rubygems'
+  require 'drb'
+  require 'gem_plugin'
+
+  RAILS_ENV = ENV['RAILS_ENV'] || 'development'
+
+  GemPlugin::Manager.instance.load 'mongrel' => GemPlugin::INCLUDE
+  DRb.start_service
+
+  def list
+    updrb.list
+  end
+  def updrb
+    @updrb ||= DRbObject.new(nil,
+      Mongrel::UploadProgressConfig.options(File.join(File.dirname(__FILE__), '../config'))[:drb]
+    )
+  end
+  def reload_updrb
+    @updrb = nil
+    updrb
+  end
+
+Then interact with IRB as follows:
+
+  $ RAILS_ENV=production irb -r path/to/above_script.rb
+  > list #=> []
+  # After an upload starts...
+  > list #=> ['1299607166']
+  # You can call any Mongrel::UploadProgress method as well
+  > updrb.check('1299607166') #=> {:received=>1024, :size=>56332114} 

data/haikulearning_mongrel_upload_progress.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{haikulearning_mongrel_upload_progress}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["The Mongrel team, with modifications by Marcos Wright Kuhns"]
-  s.date = %q{2011-03-07}
+  s.date = %q{2011-03-08}
   s.description = %q{The haikulearning fork of the mongrel_upload_progress gemplugin}
   s.email = %q{}
   s.extra_rdoc_files = ["CHANGELOG", "COPYING", "LICENSE", "README.rdoc", "lib/haikulearning_mongrel_upload_progress/init.rb"]

data/lib/haikulearning_mongrel_upload_progress/init.rb

@@ -90,15 +90,25 @@ class Mongrel::UploadProgress
   end
 end
 
-class Mongrel::UploadProgressConfig
-  class<<self
+module Mongrel::UploadProgressConfig
+  class << self
     def options(root_dir)
-      case ::RAILS_ENV
-      when 'production'
-        YAML.load_file(File.join(root_dir, 'config/mongrel_upload_progress_prod.yml'))
-      else
-        YAML.load_file(File.join(root_dir, 'config/mongrel_upload_progress_dev.yml'))
+      opts = YAML.load_file(File.join(root_dir, 'mongrel_upload_progress.yml')) rescue nil
+      raise NoConfigSpecified.new("No config file exists at #{File.join(root_dir, 'config/mongrel_upload_progress.yml').inspect}") if opts.nil? || opts.empty?
+      
+      begin
+        ::RAILS_ENV
+      rescue
+        raise NoConfigSpecified.new("The ::RAILS_ENV constant must be set (Sorry, no Rails 3 support yet.)")
       end
+      
+      opts = opts[::RAILS_ENV] rescue nil
+      raise NoConfigSpecified.new("No config information exists for the #{::RAILS_ENV} environment.") if opts.nil? || opts.empty?
+      
+      opts
     end
   end
-end
+  
+  class NoConfigSpecified < ::RuntimeError
+  end
+end 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: haikulearning_mongrel_upload_progress
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - The Mongrel team, with modifications by Marcos Wright Kuhns
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -08:00
+date: 2011-03-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency