cups 0.0.5 → 0.0.6

data/ext/cups.c

@@ -5,6 +5,40 @@ static cups_option_t *options;
 cups_dest_t *dests, *dest;
 VALUE rubyCups, printJobs;
 
+// Need to abstract this out of cups.c
+char* ipp_state_to_string(int state)
+{
+
+  char *jstate;
+
+  switch (state) {
+    case IPP_JOB_PENDING :
+      jstate = "Pending...";
+      break;
+    case IPP_JOB_HELD :
+      jstate = "Held";
+      break;
+    case IPP_JOB_PROCESSING :
+      jstate = "Processing...";
+      break;
+    case IPP_JOB_STOPPED :
+      jstate = "Stopped";
+      break;
+    case IPP_JOB_CANCELED :
+      jstate = "Cancelled";
+      break;
+    case IPP_JOB_ABORTED :
+      jstate = "Aborted";
+      break;
+    case IPP_JOB_COMPLETED :
+      jstate = "Completed";
+      break;
+    default:
+      jstate = "Unknown Job Code...";
+  }
+  return jstate;
+}
+
 
 /*
 * call-seq:
@@ -25,7 +59,12 @@ static VALUE job_init(int argc, VALUE* argv, VALUE self)
 
     // Fall back to default printer
     VALUE def_p = rb_funcall(rubyCups, rb_intern("default_printer"), 0);
-    rb_iv_set(self, "@printer", def_p);
+
+    if (def_p == Qfalse) {
+			rb_raise(rb_eRuntimeError, "There is no default printer!");
+		} else {
+			rb_iv_set(self, "@printer", def_p);
+		}
     
   } else {
     // First call Cups#show_destinations
@@ -212,34 +251,10 @@ static VALUE cups_get_job_state(VALUE self)
       }
     }
 
-     // Free job array
-     cupsFreeJobs(num_jobs, jobs);
+    // Free job array
+    cupsFreeJobs(num_jobs, jobs);
  
-    switch (job_state) {
-      case IPP_JOB_PENDING :
-        jstate = rb_str_new2("Pending...");
-        break;
-      case IPP_JOB_HELD :
-        jstate = rb_str_new2("Held");
-        break;
-      case IPP_JOB_PROCESSING :
-        jstate = rb_str_new2("Processing...");
-        break;
-      case IPP_JOB_STOPPED :
-        jstate = rb_str_new2("Stopped");
-        break;
-      case IPP_JOB_CANCELED :
-        jstate = rb_str_new2("Cancelled");
-        break;
-      case IPP_JOB_ABORTED :
-        jstate = rb_str_new2("Aborted");
-        break;
-      case IPP_JOB_COMPLETED :
-		jstate = rb_str_new2("Completed");
-        break;
-      default:
-		jstate = rb_str_new2("Unknown Job Code...");
-    }
+    jstate = rb_str_new2(ipp_state_to_string(job_state));
 
     return jstate;
   }
@@ -293,14 +308,14 @@ static VALUE cups_job_completed(VALUE self)
 *   Cups.all_jobs(printer) -> Hash
 *
 * Get all jobs from default CUPS server. Takes a single printer/class string argument.
-* Returned hash keys are CUPS job ids, and the values are arrays of job info in the
-* following order:
+* Returned hash keys are CUPS job ids, and the values are hashes of job info
+* with keys:
 *
-* [title,submitted_by,size,format,state]
+* [:title, :submitted_by, :size, :format, :state]
 */
 static VALUE cups_get_jobs(VALUE self, VALUE printer)
 {
-  VALUE job_list, job_info_ary, jid, jtitle, juser, jsize, jformat, jstate;
+  VALUE job_list, job_info_hash, jid, jtitle, juser, jsize, jformat, jstate;
   int job_id;
   int num_jobs;
   cups_job_t *jobs;
@@ -312,44 +327,21 @@ static VALUE cups_get_jobs(VALUE self, VALUE printer)
   job_list = rb_hash_new();
   
   for (i = 0; i < num_jobs; i ++) { // Construct a hash of individual job info
-    job_info_ary = rb_ary_new();
+    job_info_hash = rb_hash_new();
     jid = INT2NUM(jobs[i].id);
     jtitle = rb_str_new2(jobs[i].title);
     juser = rb_str_new2(jobs[i].user);
     jsize = INT2NUM(jobs[i].size);
     jformat = rb_str_new2(jobs[i].format);
+    jstate = rb_str_new2(ipp_state_to_string(jobs[i].state));
+
+    rb_hash_aset(job_info_hash, ID2SYM(rb_intern("title")), jtitle);
+    rb_hash_aset(job_info_hash, ID2SYM(rb_intern("submitted_by")), juser);
+    rb_hash_aset(job_info_hash, ID2SYM(rb_intern("size")), jsize);
+    rb_hash_aset(job_info_hash, ID2SYM(rb_intern("format")), jformat);
+    rb_hash_aset(job_info_hash, ID2SYM(rb_intern("state")), jstate);
     
-    // Let's elaborate on that job state...
-    switch (jobs[i].state) {
-      case IPP_JOB_PENDING :
-        jstate = rb_str_new2("Pending...");
-        break;
-      case IPP_JOB_HELD :
-        jstate = rb_str_new2("Held");
-        break;
-      case IPP_JOB_PROCESSING :
-        jstate = rb_str_new2("Processing...");
-        break;
-      case IPP_JOB_STOPPED :
-        jstate = rb_str_new2("Stopped");
-        break;
-      case IPP_JOB_CANCELED :
-        jstate = rb_str_new2("Cancelled");
-        break;
-      case IPP_JOB_ABORTED :
-        jstate = rb_str_new2("Aborted");
-        break;
-      case IPP_JOB_COMPLETED :
-        jstate = rb_str_new2("Completed");
-    }
-    
-    rb_ary_push(job_info_ary, jtitle);
-    rb_ary_push(job_info_ary, juser);
-    rb_ary_push(job_info_ary, jsize);
-    rb_ary_push(job_info_ary, jformat);
-    rb_ary_push(job_info_ary, jstate);
-    
-    rb_hash_aset(job_list, jid, job_info_ary); // And push it all into job_list hash
+    rb_hash_aset(job_list, jid, job_info_hash); // And push it all into job_list hash
   }
 
   // Free job array
@@ -391,42 +383,6 @@ static VALUE cups_get_options(VALUE self, VALUE printer)
 
 }
 
-// TODO
-// int ipp_state_to_string(int state)
-// {
-//   // char *jstate;
-//   switch (state) {
-//     case IPP_JOB_PENDING :
-//       // jstate = rb_str_new2("Pending...");
-//       // char jstate[] = "Pending...";
-//       break;
-//     case IPP_JOB_HELD :
-//       // jstate = rb_str_new2("Held");
-//       // char jstate[] = "Held";
-//       break;
-//     case IPP_JOB_PROCESSING :
-//       // jstate = rb_str_new2("Processing...");
-//       // char jstate[] = "Processing...";
-//       break;
-//     case IPP_JOB_STOPPED :
-//       // jstate = rb_str_new2("Stopped");
-//       // char jstate[] = "Stopped";
-//       break;
-//     case IPP_JOB_CANCELED :
-//       // jstate = rb_str_new2("Cancelled");
-//       // char jstate[] = "Cancelled";
-//       break;
-//     case IPP_JOB_ABORTED :
-//       // jstate = rb_str_new2("Aborted");
-//       // char jstate[] = "Aborted";
-//       break;
-//     case IPP_JOB_COMPLETED :
-//       // jstate = rb_str_new2("Completed");
-//       break;
-//   }
-//   return 0;
-// }
-
 /*
 */
 

data/ext/ruby_cups.h

@@ -1,8 +1,8 @@
 #include <cups/cups.h>
 #ifdef __APPLE__
-#include <ruby/ruby.h>
+  #include <ruby/ruby.h>
 #else
-#include <ruby.h>
+  #include <ruby.h>
 #endif
 
 #ifndef MAXOPTS

data/lib/cups/print_job/transient.rb

@@ -0,0 +1,58 @@
+require "cups"
+require "tempfile"
+require "digest/sha1"
+
+module Cups
+
+  class PrintJob
+
+    # Unlike its superclass, a Transient object takes a string of data (e.g. from an IO object).
+    # This is useful when you've got something like a PDF, an ImageMagick byte array, etc that you
+    # just want to send on its way rather than having to touch the file system directly.
+    # === A contrived example:
+    # Say we're using Prawn[http://prawn.majesticseacreature.com/] to generate PDF invoices for some nebulous,
+    # ever-expanding system that promises us sex, drugs, rock & roll, fame and perhaps a pay-rise. Instead of just
+    # generating a file, let's pass the rendered version to a Transient object and let it take care of things:
+    #
+    # ---
+    #
+    #   require 'cups/print_job/transient'
+    #   require 'prawn'
+    #
+    #   invoice = Prawn::Document.new do
+    #     text "Invoice."
+    #   end
+    #
+    #   paper_copy = Cups::PrintJob::Transient.new(invoice.render)
+    #   paper_copy.print
+    #
+    # ---
+    #
+    # As of 0.0.5, all instance methods inherited from PrintJob are unaltered. This may change if I need to
+    # delay passing the print data or change it after initialization, just as PrintJob currently permits the
+    # file to be written to/moved/nonexistent until print is called.
+    #
+    # Enjoy.
+
+    class Transient < PrintJob
+
+      alias_method :old_init, :initialize
+
+      # Create a print job from a non-empty string. Takes optional printer argument, otherwise uses default.
+      # As the tempfile is written to and closed upon initialization, an error will be raised if an empty
+      # string is passed as the first argument.
+      def initialize(data_string, printer=nil)
+        raise "Temporary print job has no data!" if data_string.empty?
+
+        sha1 = Digest::SHA1.hexdigest(Time.now.to_s)
+        file = Tempfile.new(sha1)
+        file.puts(data_string)
+        file.close
+
+        old_init(file.path, printer)
+      end
+
+    end
+
+  end
+end

data/lib/cups/printer/printer.rb

@@ -0,0 +1,35 @@
+require "cups"
+
+module Cups
+
+  # Right now this just wraps the Cups.options_for hash using method_missing, allowing you to call
+  # things like Printer#printer_make_and_model on an instance.
+  class Printer
+
+    # Creates a Cups::Printer object. Defaults to the default printer, if there is one.
+    def initialize(printer=nil)
+      if printer.nil?
+        raise "There is no default printer!" if !Cups.default_printer
+        @printer = Cups.default_printer
+      else
+        raise "The printer or destination doesn't exist!" unless Cups.show_destinations.include?(printer)
+        @printer = printer
+      end
+    end
+
+    # Call an options key on this object (with hyphens substituted with underscores). Passes onto super if
+    # no key is found or its value is nil.
+    def method_missing(m)
+      get_options
+      key = m.to_s.gsub(/\_/, "-")
+      @options[key].nil? ? super : @options[key]
+    end
+
+    private
+
+    def get_options
+      @options ||= Cups.options_for(@printer)
+    end
+
+  end
+end

data/test/cups_test.rb

@@ -60,6 +60,14 @@ class CupsTest < Test::Unit::TestCase
   def test_all_jobs_returns_hash
     assert Cups.all_jobs(Cups.default_printer).is_a?(Hash)
   end
+
+  def test_all_jobs_hash_contains_info_hash
+    pj = Cups::PrintJob.new(sample, "PDF_Printer")
+    pj.print
+    info = Cups.all_jobs("PDF_Printer")[pj.job_id]
+    assert info.is_a?(Hash)
+    assert info.keys.all?{|key| [:title, :format, :submitted_by, :state, :size].include?(key)}
+  end
   
   def test_dest_list_returns_array
     assert Cups.show_destinations.is_a?(Array)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cups
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Chris Mowforth
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 +01:00
+date: 2010-01-13 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,8 @@ files:
 - ext/cups.c
 - ext/ruby_cups.h
 - ext/extconf.rb
+- lib/cups/print_job/transient.rb
+- lib/cups/printer/printer.rb
 has_rdoc: true
 homepage: http://cups.rubyforge.org/
 licenses: []
@@ -53,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cups
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A lightweight Ruby library for printing.