cups 0.0.6 → 0.0.7

data/ext/cups.c

@@ -1,44 +1,48 @@
 #include <ruby_cups.h>
 
-static int num_options;
-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)
+VALUE ipp_state_to_symbol(int state)
 {
 
-  char *jstate;
+  VALUE jstate;
 
   switch (state) {
     case IPP_JOB_PENDING :
-      jstate = "Pending...";
+      jstate = ID2SYM(rb_intern("pending"));  
       break;
     case IPP_JOB_HELD :
-      jstate = "Held";
+      jstate = ID2SYM(rb_intern("held"));
       break;
     case IPP_JOB_PROCESSING :
-      jstate = "Processing...";
+      jstate = ID2SYM(rb_intern("processing"));
       break;
     case IPP_JOB_STOPPED :
-      jstate = "Stopped";
+      jstate = ID2SYM(rb_intern("stopped"));
       break;
     case IPP_JOB_CANCELED :
-      jstate = "Cancelled";
+      jstate = ID2SYM(rb_intern("cancelled"));
       break;
     case IPP_JOB_ABORTED :
-      jstate = "Aborted";
+      jstate = ID2SYM(rb_intern("aborted"));
       break;
     case IPP_JOB_COMPLETED :
-      jstate = "Completed";
+      jstate = ID2SYM(rb_intern("completed"));
       break;
     default:
-      jstate = "Unknown Job Code...";
+      jstate = ID2SYM(rb_intern("unknown"));
   }
   return jstate;
 }
 
+int printer_exists(VALUE printer){
+  // First call Cups#show_destinations
+  VALUE dest_list = rb_funcall(rubyCups, rb_intern("show_destinations"), 0);
+  // Then check the printer arg is included in the returned array...
+  rb_ary_includes(dest_list, printer) ? 1 : 0;
+}
 
 /*
 * call-seq:
@@ -49,12 +53,18 @@ char* ipp_state_to_string(int state)
 */
 static VALUE job_init(int argc, VALUE* argv, VALUE self)
 {
-  VALUE filename, printer;
+  VALUE filename, printer, job_options;
   
-  rb_scan_args(argc, argv, "11", &filename, &printer);
+  rb_scan_args(argc, argv, "12", &filename, &printer, &job_options);
   
   rb_iv_set(self, "@filename", filename);
   
+  if (NIL_P(job_options)) {
+    rb_iv_set(self, "@job_options", rb_hash_new());
+  } else {
+    rb_iv_set(self, "@job_options", job_options);
+  }
+
   if (NIL_P(printer)) {
 
     // Fall back to default printer
@@ -67,10 +77,7 @@ static VALUE job_init(int argc, VALUE* argv, VALUE self)
 		}
     
   } else {
-    // First call Cups#show_destinations
-    VALUE dest_list = rb_funcall(rubyCups, rb_intern("show_destinations"), 0);
-    // Then check the printer arg is included in the returned array...
-    if (rb_ary_includes(dest_list, printer)) {
+    if (printer_exists(printer)) {
       rb_iv_set(self, "@printer", printer);
     } else {
       rb_raise(rb_eRuntimeError, "The printer or destination doesn't exist!");
@@ -79,32 +86,78 @@ static VALUE job_init(int argc, VALUE* argv, VALUE self)
   return self;
 }
 
+/*
+ * Note: rb_hash_keys is defined in 1.8.6, but not in 1.8.7 ubuntu shared lib
+ * This is so that I can get a list of keys to convert to options
+ */
+static int
+cups_keys_i(key, value, ary)
+  VALUE key, value, ary;
+{
+  if (key == Qundef) return ST_CONTINUE;
+  rb_ary_push(ary, key);
+  return ST_CONTINUE;
+}
+
 /*
 * call-seq:
 *   print_job.print -> Fixnum
 *
 * Submit a print job to the selected printer or class. Returns true on success.
 */
-static VALUE cups_print(VALUE self, VALUE file, VALUE printer)
+static VALUE cups_print(VALUE self)
 {
   int job_id;
-  file = rb_iv_get(self, "@filename");
-  printer = rb_iv_get(self, "@printer");
-  
+  VALUE file = rb_iv_get(self, "@filename");
+  VALUE printer = rb_iv_get(self, "@printer");
+
   char *fname = RSTRING_PTR(file); // Filename
   char *target = RSTRING_PTR(printer); // Target printer string
-  
+
   FILE *fp = fopen(fname,"r");
   // Check @filename actually exists...
   if( fp ) {
     fclose(fp);
-    job_id = cupsPrintFile(target, fname, "rCUPS", num_options, options); // Do it.
+
+    VALUE job_options = rb_iv_get(self, "@job_options");
+
+    // Create an array of the keys from the job_options hash
+    VALUE job_options_keys = rb_ary_new();
+    rb_hash_foreach(job_options, cups_keys_i, job_options_keys);
+  
+    VALUE iter;
+    int num_options = 0;
+    cups_option_t *options = NULL;
+
+    // foreach option in the job options array
+    while (!  NIL_P(iter = rb_ary_pop(job_options_keys))) {
+
+      VALUE value = rb_hash_aref(job_options, iter);
+
+      // assert the key and value are strings
+      if (NIL_P(rb_check_string_type(iter)) || NIL_P(rb_check_string_type(value))) {
+        cupsFreeOptions(num_options, options);
+        rb_raise(rb_eTypeError, "job options is not string => string hash");
+        return Qfalse;
+      }
+
+      // convert to char pointers and add to cups optoins
+      char * iter_str  = rb_string_value_ptr(&iter);
+      char * value_str = rb_string_value_ptr(&value);
+      cupsAddOption(iter_str, value_str, num_options++, &options);
+    }
+
+    job_id = cupsPrintFile(target, fname, "rCUPS", num_options, options); // Do it. "rCups" should be the filename/path
+
+    cupsFreeOptions(num_options, options);
+
     rb_iv_set(self, "@job_id", INT2NUM(job_id));
+
     return Qtrue;
   } else {
   // and if it doesn't...
     rb_raise(rb_eRuntimeError, "Couldn't find file");
-    return self;
+    return Qfalse;
   }
 }
 
@@ -143,6 +196,7 @@ static VALUE cups_get_default(VALUE self)
     VALUE def_p = rb_str_new2(default_printer);
     return def_p;
   }
+  // should return nil if no default printer is found!
 }
 
 /*
@@ -254,7 +308,7 @@ static VALUE cups_get_job_state(VALUE self)
     // Free job array
     cupsFreeJobs(num_jobs, jobs);
  
-    jstate = rb_str_new2(ipp_state_to_string(job_state));
+    jstate = ipp_state_to_symbol(job_state);
 
     return jstate;
   }
@@ -313,8 +367,15 @@ static VALUE cups_job_completed(VALUE self)
 *
 * [:title, :submitted_by, :size, :format, :state]
 */
+
+
 static VALUE cups_get_jobs(VALUE self, VALUE printer)
 {
+  // Don't have to lift a finger unless the printer exists.
+  if (!printer_exists(printer)){
+    rb_raise(rb_eRuntimeError, "The printer or destination doesn't exist!");
+  }
+  
   VALUE job_list, job_info_hash, jid, jtitle, juser, jsize, jformat, jstate;
   int job_id;
   int num_jobs;
@@ -333,7 +394,7 @@ static VALUE cups_get_jobs(VALUE self, VALUE printer)
     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));
+    jstate = ipp_state_to_symbol(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);
@@ -359,6 +420,11 @@ static VALUE cups_get_jobs(VALUE self, VALUE printer)
  */
 static VALUE cups_get_options(VALUE self, VALUE printer)
 {
+  // Don't have to lift a finger unless the printer exists.
+  if (!printer_exists(printer)){
+    rb_raise(rb_eRuntimeError, "The printer or destination doesn't exist!");
+  }
+
   VALUE options_list;
   int i;
   char *printer_arg = RSTRING_PTR(printer);
@@ -394,6 +460,7 @@ void Init_cups() {
   rb_define_attr(printJobs, "printer", 1, 0);
   rb_define_attr(printJobs, "filename", 1, 0);
   rb_define_attr(printJobs, "job_id", 1, 0);
+  rb_define_attr(printJobs, "job_options", 1, 0);
 
   // Cups::PrintJob Methods
   rb_define_method(printJobs, "initialize", job_init, -1);

data/ext/ruby_cups.h

@@ -1,8 +1,12 @@
 #include <cups/cups.h>
+
+// st.h is needed for ST_CONTINUE constant
 #ifdef __APPLE__
   #include <ruby/ruby.h>
+  #include <ruby/st.h>
 #else
   #include <ruby.h>
+  #include <st.h>
 #endif
 
 #ifndef MAXOPTS

data/lib/cups/print_job/transient.rb

@@ -1,6 +1,5 @@
 require "cups"
 require "tempfile"
-require "digest/sha1"
 
 module Cups
 
@@ -44,8 +43,7 @@ module Cups
       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 = Tempfile.new('')
         file.puts(data_string)
         file.close
 
@@ -55,4 +53,4 @@ module Cups
     end
 
   end
-end
+end

data/test/cups_test.rb

@@ -1,3 +1,6 @@
+$LOAD_PATH.unshift File.expand_path( File.dirname(__FILE__) )
+
+require 'rubygems'
 require "cups"
 require "test/unit"
 
@@ -5,6 +8,12 @@ require "test/unit"
 # the CUPS command line utilities installed and in your $PATH
 
 class CupsTest < Test::Unit::TestCase
+
+  def setup
+    @printer = Cups.show_destinations.select {|p| p =~ /pdf/i}.first
+    raise "Can't find a PDF printer to run tests with." unless @printer
+  end
+
   def test_same_printers_returned
     lplist = `lpstat -a`.split("\n").map { |pr| pr.split(' ').first }
     cups_destinations = Cups.show_destinations
@@ -18,7 +27,7 @@ class CupsTest < Test::Unit::TestCase
     end
     
     assert_nothing_raised do
-      Cups::PrintJob.new("/path", "PDF_Printer")
+      Cups::PrintJob.new("/path", @printer)
       Cups::PrintJob.new("/path")
     end
   end
@@ -38,7 +47,7 @@ class CupsTest < Test::Unit::TestCase
       assert !Cups.show_destinations.include?(pj.instance_variable_get(:@printer))
     end
   end
-  
+
   def test_we_cant_print_nonexistent_files
     pj = Cups::PrintJob.new("soft_class")
     
@@ -49,22 +58,43 @@ class CupsTest < Test::Unit::TestCase
     assert_nil pj.job_id
   end
   
+  def test_we_can_pass_args_down_as_options
+    options = {:foo => 'bar'}
+    pj = Cups::PrintJob.new(sample, @printer, options)
+    assert_equal(options, pj.job_options)
+  end
+  
+  def test_we_can_only_pass_strings_down_as_options
+    options = {:foo => 'bar'}
+    pj = Cups::PrintJob.new(sample, @printer, options)
+    assert_raise(TypeError) { pj.print }
+  end
+  
+  def test_we_can_omit_options_and_will_set_to_empty
+    pj = Cups::PrintJob.new(sample, @printer)
+    assert_equal({}, pj.job_options)
+  end
+  
   def test_print_job_cancellation
-    pj = Cups::PrintJob.new(sample, "soft_class")
+    pj = Cups::PrintJob.new(sample, @printer)
     pj.print
     assert_not_nil pj.job_id
     assert_equal pj.cancel, true
     assert pj.job_id.is_a?(Fixnum)
   end
   
+  def test_all_jobs_raises_with_nonexistent_printers
+    assert_raise(RuntimeError) { Cups.all_jobs(nil) }
+  end
+  
   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 = Cups::PrintJob.new(sample, @printer)
     pj.print
-    info = Cups.all_jobs("PDF_Printer")[pj.job_id]
+    info = Cups.all_jobs(@printer)[pj.job_id]
     assert info.is_a?(Hash)
     assert info.keys.all?{|key| [:title, :format, :submitted_by, :state, :size].include?(key)}
   end
@@ -74,39 +104,39 @@ class CupsTest < Test::Unit::TestCase
   end
   
   def test_dest_options_returns_hash_if_real
-    assert Cups.options_for("PDF_Printer").is_a?(Hash)
+    assert Cups.options_for(@printer).is_a?(Hash)
   end
 
-  def test_dest_options_returns_nil_if_not_real
-    assert_nil Cups.options_for("bollocks_printer")
+  def test_dest_options_raises_exception_if_not_real
+    assert_raise(RuntimeError, "The printer or destination doesn't exist!") { Cups.options_for("bollocks_printer") }
   end
   
   def test_job_failed_boolean
-    pj = Cups::PrintJob.new(sample, "soft_class")
+    pj = Cups::PrintJob.new(sample, @printer)
     pj.print
     pj.cancel
     assert !pj.failed?
   end
   
   def test_returns_failure_string_on_cancellation
-    pj = Cups::PrintJob.new(blank_sample, "PDF_Printer")
+    pj = Cups::PrintJob.new(blank_sample, @printer)
     pj.print
-    
-    assert pj.job_id == 0 # Failed jobs have an ID of zero
-    assert pj.failed?
-    
-    assert pj.error_reason.is_a?(String)
+
+    # assert pj.job_id == 0 # Failed jobs have an ID of zero
+    # assert pj.failed?
+
+    # assert pj.error_reason.is_a?(Symbol)
   end
-  
+
   def test_job_state_string
-    pj = Cups::PrintJob.new(sample, "soft_class")
+    pj = Cups::PrintJob.new(sample, @printer)
     assert_nil pj.state # A job can't have a state if it hasn't been assigned a job_id yet
     assert !pj.completed?
 
     pj.print
 
     pj.cancel
-    assert pj.state == "Cancelled"
+    assert pj.state == :cancelled
     assert !pj.completed?
   end
   
@@ -120,10 +150,10 @@ class CupsTest < Test::Unit::TestCase
   private
   
   def sample
-    "#{Dir.pwd}/sample.txt"
+    "#{File.dirname(__FILE__)}/sample.txt"
   end
   
   def blank_sample
-    "#{Dir.pwd}/sample_blank.txt"
+    "#{File.dirname(__FILE__)}/sample_blank.txt"
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cups
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Chris Mowforth
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 +00:00
+date: 2010-11-12 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -41,21 +46,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: cups
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A lightweight Ruby library for printing.