beanstalkd_view 1.0.2 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+1.1.0
+-----------
+
+- Switched from beanstalk-client to beaneater gem
+
+
 1.0.2
 -----------
 

data/Gemfile

@@ -1,5 +1,7 @@
 source "http://rubygems.org"
 
+#gem 'beaneater', :git => 'https://github.com/beanstalkd/beaneater.git'
+
 # Specify your gem's dependencies in beanstalkd_view.gemspec
 gemspec
 

data/README.md

@@ -10,7 +10,6 @@ Configuration
 To use in a Rails app, include the gem in your Gemfile:
 
 ``` ruby
-gem 'beanstalk-client', :git => 'https://github.com/kr/beanstalk-client-ruby.git' #Use the latest, if you need the pause-tube command
 gem beanstalkd_view
 ```
 
@@ -23,7 +22,7 @@ Use the following environment variable to specify the location of the beanstalk
 ENV['BEANSTALK_URL'] = 'beanstalk://localhost/'
 ```
 
-(This can be a comma separated list.)
+This can be a comma separated list, e.g. 'beanstalk://localhost:11300,beanstalk://localhost:11400'
 
 Embedding in a Rails app
 ------------------------
@@ -63,12 +62,22 @@ bundle exec beanstalkd_view
 
 (This will use the vegas gem to launch the Sinatra app on an available port.)
 
-Alternatively, a Rackup file is provided.  To use: cd into the beanstalkd_view directory and execute the rackup command.
+Alternatively, a Rackup file is provided.  To use: cd into the beanstalkd_view directory and execute:
+
+rackup
+
 
 Screenshot
 ------------------------
 ![Screenshot](http://s16.postimage.org/4mdum0x79/i_OS_Simulator_Screen_shot_Apr_24_2012_10_29_33.png)
 
+Running the tests
+------------------------
+There are 3 variants of RSpec tests.
+* Without beanstalkd running, just execute: rspec spec
+* Without 1 instance of beanstalkd running (default port), execute: rspec spec --tag requires_beanstalkd
+* Without 2 instances of beanstalkd running (ports 11300 and 11400), execute: rspec spec --tag requires_two_beanstalkd
+
 License
 ------------------------
 

data/Rakefile

@@ -10,7 +10,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default  => :spec
 
-require 'beanstalk-client'
+require 'beaneater'
 require 'json'
 
 namespace :beanstalkd_view do
@@ -21,17 +21,17 @@ namespace :beanstalkd_view do
   task :enqueue_test do
     host = "localhost"
     port = 11300
-    beanstalk = Beanstalk::Pool.new([ "#{host}:#{port}" ])
+    beanstalk = Beaneater::Pool.new([ "#{host}:#{port}" ])
 
     # Loop flooding the queues with jobs
     while true
-      tube = TEST_QUEUES.sample
+      tube_name = TEST_QUEUES.sample
       pri = 65536
       delay = 0
       ttr = 120
-      beanstalk.use tube
-      beanstalk.put [ tube, {} ].to_json, pri, delay, ttr
-      puts "Enqueued Job to #{tube}"
+      tube = beanstalk.tubes[tube_name]
+      tube.put '{}', :pri => pri, :delay => delay, :ttr => ttr
+      puts "Enqueued Job to #{tube_name}"
     end
   end
   
@@ -39,14 +39,20 @@ namespace :beanstalkd_view do
   task :pull_test do
     host = "localhost"
     port = 11300
-    beanstalk = Beanstalk::Pool.new([ "#{host}:#{port}" ])
+    beanstalk = Beaneater::Pool.new([ "#{host}:#{port}" ])
 
     while true
-      tube = TEST_QUEUES.sample
-      beanstalk.watch(tube)
-      job = beanstalk.reserve
-      puts "Pulled Job #{job} from #{tube}"
-      job.delete
+      tube_name = TEST_QUEUES.sample
+      begin
+        beanstalk.tubes.watch!(tube_name)
+        job = beanstalk.tubes.reserve(1)
+        if job
+          puts "Pulled Job #{job} from #{tube_name}"
+          job.delete
+        end
+      rescue Exception => ex
+        puts "Exception while pulling job from #{tube_name}: #{ex}"
+      end
     end
   end
   

data/lib/beanstalkd_view/beanstalkd_utils.rb

@@ -2,10 +2,12 @@ module BeanstalkdView
     
   module BeanstalkdUtils
     
+    GUESS_PEEK_RANGE = 100 # Default number of elements to use in peek-range guesses
+
     class BadURL < RuntimeError; end
     
     def beanstalk
-      @@beanstalk ||= Beanstalk::Pool.new(beanstalk_addresses)
+      @@beanstalk ||= Beaneater::Pool.new(beanstalk_addresses)
     end
 
     def beanstalk_url
@@ -13,8 +15,6 @@ module BeanstalkdView
       ENV['BEANSTALK_URL'] || 'beanstalk://localhost/'
     end
 
-    class BadURL < RuntimeError; end
-
     def beanstalk_addresses
       uris = beanstalk_url.split(/[\s,]+/)
       uris.map {|uri| beanstalk_host_and_port(uri)}
@@ -25,5 +25,67 @@ module BeanstalkdView
       raise(BadURL, uri_string) if uri.scheme != 'beanstalk'
       "#{uri.host}:#{uri.port || 11300}"
     end
+
+    # Convert Beaneater::Job to hash
+    def job_to_hash(job)
+      ret_value = {}
+      job_stats = job.stats
+      job_stats.keys.each { |key| ret_value[key] = job_stats[key] }
+      ret_value['body'] = job.body.inspect
+      ret_value
+    end
+        
+    # Return the stats data in a format for the Bluff JS UI Charts
+    def get_chart_data_hash(tubes)
+      chart_data = {}
+      chart_data["total_jobs_data"] = Hash.new
+      chart_data["buried_jobs_data"] = Hash.new
+      chart_data["total_jobs_data"]["items"] = Array.new
+      chart_data["buried_jobs_data"]["items"] = Array.new 
+      tubes.each do |tube|
+        stats = tube.stats
+        #total_jobs
+        total_jobs = stats[:total_jobs]
+          if total_jobs > 0
+          total_datum = {}
+          total_datum["label"] = tube.name
+          total_datum["data"] = total_jobs
+          chart_data["total_jobs_data"]["items"] << total_datum
+        end
+        #buried_jobs
+        buried_jobs = stats[:current_jobs_buried]
+        if buried_jobs > 0
+          buried_datum = {}
+          buried_datum["label"] = tube.name
+          buried_datum["data"] = buried_jobs
+          chart_data["buried_jobs_data"]["items"] << buried_datum
+        end
+      end
+      chart_data
+    end
+    
+    # Pick a Minimum Peek Range Based on minumum ready jobs on all tubes
+    def guess_min_peek_range(tubes)
+      min = 0
+      tubes.each do |tube|
+        response = tube.peek('ready')
+        if response
+          if min == 0
+            min = response.id.to_i
+          else
+            min = [min, response.id.to_i].min
+          end
+        end
+      end
+      # Add some jitter in the opposite direction of 1/4 range
+      jitter_min = (min-(GUESS_PEEK_RANGE*0.25)).to_i
+      [1, jitter_min].max
+    end
+    
+    # Pick a Minimum Peek Range Based on the minimum
+    def guess_max_peek_range(min)
+      (min+GUESS_PEEK_RANGE)-1
+    end
+
   end
 end

data/lib/beanstalkd_view/resources/js/peek_jobs.js

@@ -85,10 +85,11 @@ $(document).ready(function() {
     } else {
       // Build the confirmation popup
       data = {};
+      data["tube"] = tube;
       data["pri"] = priority;
       data["delay"] = delay;
       data["ttr"] = ttr;
-      data["body"] = JSON.stringify([tube, parsed_body_json]);
+      data["body"] = JSON.stringify(parsed_body_json);
       $("#job_info_popup_title").html(create_new_job_title());      
       $("#job_info_popup_body").html(create_job_info_table(data));
       $("#job_info_popup_footer").html(create_new_job_buttons());
@@ -127,6 +128,7 @@ $(document).ready(function() {
   function create_job_info_table(data) {
     var job_info_table = "<table class=\"table\">";
     job_info_table += "<tbody>";
+    job_info_table += create_job_info_row("tube", data["tube"], "The tube to which the job will be added.");      
     job_info_table += create_job_info_row("pri", data["pri"], "The priority value set by the put, release, or bury commands.");      
     if ("age" in data) {
       job_info_table += create_job_info_row("age", data["age"], "The time in seconds since the put command that created this job.");

data/lib/beanstalkd_view/resources/js/peek_range.js

@@ -3,10 +3,10 @@ $(document).ready(function() {
   function filter_table_by_tube() {
     var tube = $("#peek_range_tube_select").val();
     if (tube === '') {
-      $('tr[data-tube]').show();
+      $('tr.datum[data-tube]').show();
     } else {
-      $('tr[data-tube!="'+tube+'"]').hide();
-      $('tr[data-tube="'+tube+'"]').show();
+      $('tr.datum[data-tube!="'+tube+'"]').hide();
+      $('tr.datum[data-tube="'+tube+'"]').show();
     }
   }
 

data/lib/beanstalkd_view/server.rb

@@ -30,19 +30,17 @@ module BeanstalkdView
         '/css/vendor/bootstrap.min.css', 
         '/css/app.css']
     end
-    
-    GUESS_PEEK_RANGE = 100 # Default number of elements to use in peek-range guesses
-      
+          
     get "/" do
       begin
-        @tubes = beanstalk.list_tubes
+        @connections = beanstalk.connections
+        @tubes = beanstalk.tubes.all
         @stats = beanstalk.stats
-        @tube_set = tube_set(@tubes)
-        chart_data = get_chart_data_hash(@tube_set)
+        chart_data = get_chart_data_hash(@tubes)
         @total_jobs_data = chart_data["total_jobs_data"]
         @buried_jobs_data = chart_data["buried_jobs_data"] if chart_data["buried_jobs_data"]["items"].size > 0
         erb :index
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
@@ -50,28 +48,27 @@ module BeanstalkdView
     post "/add_job" do
       begin
         response = nil
-        body = JSON.parse(params[:body])
-        beanstalk.on_tube(params[:tube]) do |conn|
-          response = conn.put([ params[:tube], body ].to_json, params[:priority].to_i, params[:delay].to_i, params[:ttr].to_i)
-        end
+        tube = beanstalk.tubes[params[:tube]]
+        response = tube.put params[:body], 
+          :pri => params[:priority].to_i, :delay => params[:delay].to_i, :ttr => params[:ttr].to_i
         if response
-          cookies[:beanstalkd_view_notice] = "Added job #{response.inspect}"
+          cookies[:beanstalkd_view_notice] = "Added job: #{response.inspect}"
           redirect url("/")
         else
           cookies[:beanstalkd_view_notice] = "Error adding job"
           redirect url("/")
         end
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
     
     get "/tube/:tube" do
       begin
-        @tube = params[:tube]
-        @stats = beanstalk.stats_tube(@tube)
+        @tube = beanstalk.tubes[params[:tube]]
+        @stats = @tube.stats
         erb :tube_stats
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
@@ -79,24 +76,14 @@ module BeanstalkdView
     get "/peek/:tube/:type" do
       content_type :json
       begin
-        response = nil
-        beanstalk.on_tube(params[:tube]) do |conn|
-          if (params[:type]) == "ready"
-            response = conn.peek_ready()
-          elsif (params[:type]) == "delayed"
-            response = conn.peek_delayed()
-          else
-            response = conn.peek_buried()
-          end
-        end
+        tube = beanstalk.tubes[params[:tube]]
+        response = tube.peek(params[:type])
         if response
-          ret_value = response.stats
-          ret_value["body"] = response.body
-          ret_value.to_json
+          job_to_hash(response).to_json
         else
           { :error => "No job was found, or an error occurred while trying to peek at the next job."}.to_json
         end
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         { :error => @error.to_s }.to_json
       end
     end
@@ -105,15 +92,15 @@ module BeanstalkdView
       begin
         @min = params[:min].to_i
         @max = params[:max].to_i
-        @tube = params[:tube]
+        @min = params[:min].to_i
+        tubes = beanstalk.tubes
+        @tubes = tubes.all
+        @tube = tubes[params[:tube]] if params[:tube] and params[:tube] != ''
         
-        # Get the Set of Tubes for the Form
-        tubes = beanstalk.list_tubes
-        @tube_set = tube_set(tubes)
         # Only guess with the specified tube (if passed in)
-        guess_tubes = @tube_set
-        if @tube and not @tube.empty?
-          guess_tubes = Set.new
+        guess_tubes = @tubes
+        if @tube
+          guess_tubes = []
           guess_tubes << @tube
         end
         # Guess ID Range if not specified
@@ -123,20 +110,16 @@ module BeanstalkdView
         @jobs = []
         for i in min..max
           begin
-            response = beanstalk.peek_job(i)
-            if response
-              ret_value = response.stats
-              ret_value["body"] = response.body
-              parsed_body = JSON.parse(response.body)
-              ret_value["tube"] = parsed_body[0]
-              @jobs << ret_value
+            jobs = beanstalk.jobs.find_all(i)
+            jobs.each do |job|
+              @jobs << job_to_hash(job)
             end
-          rescue Exception => e
-            #puts "Ignoring NotFoundError: #{ex.class}: #{ex}"
+          rescue Beaneater::NotFoundError => e
+            # Since we're looping over potentially non-existant jobs, ignore
           end
         end
         erb :peek_range
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
@@ -144,9 +127,8 @@ module BeanstalkdView
     get "/delete/:tube/:job_id" do
        begin
           response = nil
-          beanstalk.on_tube(params[:tube]) do |conn|
-            response = conn.delete(params[:job_id].to_i)
-          end
+          job = beanstalk.jobs.find(params[:job_id].to_i)
+          response = job.delete if job
           if response
             cookies[:beanstalkd_view_notice] = "Deleted Job #{params[:job_id]}"
             redirect url("/tube/#{params[:tube]}")
@@ -154,14 +136,15 @@ module BeanstalkdView
             cookies[:beanstalkd_view_notice] = "Error deleting Job #{params[:job_id]}"
             redirect url("/tube/#{params[:tube]}")
           end
-        rescue Beanstalk::NotConnected => @error
+        rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
           erb :error
         end
     end
     
     post "/pause" do
       begin
-        response = beanstalk.pause_tube(params[:tube], params[:delay].to_i)
+        tube = beanstalk.tubes[params[:tube]]
+        response = tube.pause(params[:delay].to_i)
         if response
           cookies[:beanstalkd_view_notice] = "Paused #{params[:tube]}. No jobs will be reserved for #{params[:delay].to_i} seconds."
           redirect url("/tube/#{params[:tube]}")
@@ -169,10 +152,7 @@ module BeanstalkdView
           cookies[:beanstalkd_view_notice] = "Error pausing #{params[:tube]}."
           redirect url("/tube/#{params[:tube]}")
         end
-      rescue NameError => @error
-        cookies[:beanstalkd_view_notice] = "The pause_tube method is currently not implemented by this version of beanstalk-client."
-        redirect url("/tube/#{params[:tube]}")
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
@@ -180,17 +160,16 @@ module BeanstalkdView
     post "/kick" do
       begin
         response = nil
-        beanstalk.on_tube(params[:tube]) do |conn|
-          response = conn.kick(params[:bound].to_i)
-        end
+        tube = beanstalk.tubes[params[:tube]]
+        response = tube.kick(params[:bound].to_i)
         if response
-          cookies[:beanstalkd_view_notice] = "Kicked #{params[:tube]} for #{response} jobs."
+          cookies[:beanstalkd_view_notice] = "Kicked #{params[:tube]}: #{response}"
           redirect url("/tube/#{params[:tube]}")
         else
           cookies[:beanstalkd_view_notice] = "Error kicking #{params[:tube]}."
           redirect url("/tube/#{params[:tube]}")
         end
-      rescue Beanstalk::NotConnected => @error
+      rescue Beaneater::NotConnected, Beaneater::NotFoundError => @error
         erb :error
       end
     end
@@ -200,6 +179,8 @@ module BeanstalkdView
     end
     alias_method :u, :url_path
 
+    private
+
     def path_prefix
       request.env['SCRIPT_NAME']
     end
@@ -209,78 +190,6 @@ module BeanstalkdView
       cookies[:beanstalkd_view_notice] = ''
       message
     end
-
-    private
-        
-    # Return the stats data in a format for the Bluff JS UI Charts
-    def get_chart_data_hash(tube_set)
-      chart_data = Hash.new
-      chart_data["total_jobs_data"] = Hash.new
-      chart_data["buried_jobs_data"] = Hash.new
-      chart_data["total_jobs_data"]["items"] = Array.new
-      chart_data["buried_jobs_data"]["items"] = Array.new 
-      tube_set.each do |tube|
-        begin
-          stats = beanstalk.stats_tube(tube)
-          #total_jobs
-          total_jobs = stats['total-jobs']
-            if total_jobs > 0
-            total_datum = Hash.new
-            total_datum["label"] = tube
-            total_datum["data"] = total_jobs
-            chart_data["total_jobs_data"]["items"] << total_datum
-          end
-          #buried_jobs
-          buried_jobs = stats['current-jobs-buried']
-          if buried_jobs > 0
-            buried_datum = Hash.new
-            buried_datum["label"] = tube
-            buried_datum["data"] = buried_jobs
-            chart_data["buried_jobs_data"]["items"] << buried_datum
-          end
-        rescue Beanstalk::NotFoundError
-          puts "Ignoring Beanstalk::NotFoundError for #{tube}"
-        end
-      end
-      chart_data
-    end
     
-    # Return a Set of tube names
-    def tube_set(tubes)
-      tube_set = Set.new
-      tubes.keys.each do |key|
-        tubes[key].each do |tube|
-          tube_set.add(tube)
-        end
-      end
-      tube_set
-    end
-    
-    # Pick a Minimum Peek Range Based on calls to peek_ready
-    def guess_min_peek_range(tube_set)
-      min = 0
-      tube_set.each do |tube|
-        response = nil
-        beanstalk.on_tube(tube) do |conn|
-          response = conn.peek_ready()
-        end
-        if response
-          if min == 0
-            min = response.id
-          else
-            min = [min, response.id].min
-          end
-        end
-      end
-      # Add some jitter in the opposite direction of 1/4 range
-      jitter_min = (min-(GUESS_PEEK_RANGE*0.25)).to_i
-      [1, jitter_min].max
-    end
-    
-    # Pick a Minimum Peek Range Based on the minimum
-    def guess_max_peek_range(min)
-      (min+GUESS_PEEK_RANGE)-1
-    end
-
   end  
 end

data/lib/beanstalkd_view/version.rb

@@ -1,3 +1,3 @@
 module BeanstalkdView
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end