win_print 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4c9ec9f2cb3dbe56a56e7be657a11a328b560f5
+  data.tar.gz: b3cd3d756d12f372f4eba2066a8779ee10d757e4
+SHA512:
+  metadata.gz: 1da3c04d2a40ce3cfd9cde2f3848b01f2a7daad91fbf3805fca1bd0c111054f34604945409c8a6aa2e5049da348f1b09483960607c68629d6ce585b05991affa
+  data.tar.gz: 0c59f7faf4dd4884c2ddbfd328f5df0b313d1b30d975b7a8c329a55e172427a4f74569ee8ab0fc8a5428fb9c47629fec7080d5b00bd603c272044d3d5bfb1cef

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "ext"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :compile do
+  puts "Compiling extension"
+  `cd ext && make clean`
+  `cd ext && ruby extconf.rb`
+  `cd ext && make`
+  puts "Done"
+end
+
+task :default => :test

data/ext/extconf.rb

@@ -0,0 +1,6 @@
+require "mkmf"
+
+abort "No winspool" unless have_library "winspool"
+$LDFLAGS = '-lwinspool'
+
+create_makefile "extension"

data/ext/extension.c

@@ -0,0 +1,43 @@
+#include "ruby/ruby.h"
+#include "ruby/encoding.h"
+#include "raw_print.h"
+
+// Get printer names of all system printers.
+static VALUE get_printer_names(VALUE self) {
+  char errMsg[1024];
+  VALUE arr = rb_ary_new();
+  int success = GetPrinterNames(arr, errMsg);
+  if (success == 0) {
+    rb_enc_raise(rb_enc_find("CP1252"), rb_eRuntimeError, errMsg);
+  }
+  return arr;
+}
+
+// Send raw data to a system printer.
+static VALUE raw_print(VALUE self, VALUE printer_name, VALUE data, VALUE doc_name) {
+  Check_Type(printer_name, T_STRING);
+  Check_Type(data, T_STRING);
+  Check_Type(doc_name, T_STRING);
+
+  char* pointer_printer_name = StringValueCStr(printer_name);
+  char* pointer_data = RSTRING_PTR(StringValue(data));
+  int data_len = RSTRING_LEN(StringValue(data));
+  char* pointer_doc_name = StringValueCStr(doc_name);
+
+  char errMsg[1024];
+  int boolean_out = RawDataToPrinter( pointer_printer_name, pointer_data, data_len, pointer_doc_name, errMsg );
+  if (boolean_out == 0) {
+    rb_enc_raise(rb_enc_find("CP1252"), rb_eRuntimeError, errMsg);
+  }
+  return Qtrue;
+}
+
+// Register class methods:
+//   WinPrint::Native.get_printer_names
+//   WinPrint::Native.raw_print
+void Init_extension(void) {
+  VALUE WinPrint = rb_define_module("WinPrint");
+  VALUE Native = rb_define_class_under(WinPrint, "Native", rb_cObject);
+  rb_define_singleton_method(Native, "get_printer_names", get_printer_names, 0);
+  rb_define_singleton_method(Native, "raw_print", raw_print, 3);
+}

data/ext/raw_print.c

@@ -0,0 +1,153 @@
+#include <ruby/ruby.h>
+#include <windows.h>
+#include <stdio.h>
+
+// This code is partially based on examples from here:
+// https://support.microsoft.com/de-de/help/138594/howto-send-raw-data-to-a-printer-by-using-the-win32-api
+
+// **********************************************************************
+// GetErrorMessage - get message from error code information
+//
+// Params:
+//   dwError       - the error code, usually from GetLastError()
+//   lpString      - some caller-defined text to include with the error info
+//   errMsg        - buffer to store the message in
+//
+// Returns: void
+//
+void GetErrorMessage( DWORD dwError, LPCTSTR lpString, char *errMsg )
+{
+#define MAX_MSG_BUF_SIZE 512
+	TCHAR *msgBuf;
+	DWORD	cMsgLen;
+
+	cMsgLen = FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM |
+				FORMAT_MESSAGE_ALLOCATE_BUFFER | 40, NULL, dwError,
+				MAKELANGID(0, SUBLANG_ENGLISH_US), (LPTSTR) &msgBuf,
+				MAX_MSG_BUF_SIZE, NULL );
+	sprintf( errMsg, TEXT("%s Error [%d]: %s"), lpString, dwError, msgBuf );
+	LocalFree( msgBuf );
+#undef MAX_MSG_BUF_SIZE
+}
+// **********************************************************************
+
+// **********************************************************************
+// GetPrinterNames - return a ruby array with printer names
+//
+// Params:
+//   arr           - ruby array to put the printer names in
+//   errMsg        - Buffer to store the error message in
+//
+// Returns: TRUE for success, FALSE for failure.
+//
+BOOL GetPrinterNames(VALUE arr, char *errMsg) {
+    BOOL success = TRUE;
+    PRINTER_INFO_1* prninfo = NULL;
+    DWORD needed, returned;
+
+    // find required size for the buffer
+    EnumPrinters(PRINTER_ENUM_LOCAL, NULL, 1, NULL, 0, &needed, &returned);
+
+    // allocate array of PRINTER_INFO structures
+    prninfo = (PRINTER_INFO_1*) GlobalAlloc(GPTR, needed);
+
+    // call again
+    if (!EnumPrinters(PRINTER_ENUM_LOCAL, NULL,
+        1, (LPBYTE) prninfo, needed, &needed, &returned)) {
+          GetErrorMessage( GetLastError(), TEXT("EnumPrinters"), errMsg );
+          success = FALSE;
+    } else {
+        for (DWORD i=0; i < returned; i++) {
+            if ((prninfo[i].Flags & PRINTER_ENUM_ICON8) == PRINTER_ENUM_ICON8) {
+                rb_ary_push(arr, rb_str_new2(prninfo[i].pName));
+            }
+        }
+    }
+
+    GlobalFree(prninfo);
+
+    return success;
+}
+// **********************************************************************
+
+// **********************************************************************
+// RawDataToPrinter - sends binary data directly to a printer
+//
+// Params:
+//   szPrinterName - NULL terminated string specifying printer name
+//   lpData        - Pointer to raw data bytes
+//   dwCount       - Length of lpData in bytes
+//   docName       - Name of the document, displayed in the printer queue
+//   errMsg        - Buffer to store the error message in
+//
+// Returns: TRUE for success, FALSE for failure.
+//
+BOOL RawDataToPrinter( LPTSTR szPrinterName, LPBYTE lpData, DWORD dwCount, LPTSTR docName, char *errMsg )
+{
+	HANDLE     hPrinter;
+	DOC_INFO_1 DocInfo;
+	DWORD      dwJob;
+	DWORD      dwBytesWritten;
+
+	// Need a handle to the printer.
+	if( ! OpenPrinter( szPrinterName, &hPrinter, NULL ) )
+	{
+		GetErrorMessage( GetLastError(), TEXT("OpenPrinter"), errMsg );
+		return FALSE;
+	}
+
+	// Fill in the structure with info about this "document."
+	DocInfo.pDocName = docName;
+	DocInfo.pOutputFile = NULL;
+	DocInfo.pDatatype = TEXT("RAW");
+	// Inform the spooler the document is beginning.
+	if( (dwJob = StartDocPrinter( hPrinter, 1, (LPBYTE)&DocInfo )) == 0 )
+	{
+		GetErrorMessage( GetLastError(), TEXT("StartDocPrinter"), errMsg );
+		ClosePrinter( hPrinter );
+		return FALSE;
+	}
+	// Start a page.
+	if( ! StartPagePrinter( hPrinter ) )
+	{
+		GetErrorMessage( GetLastError(), TEXT("StartPagePrinter"), errMsg );
+		EndDocPrinter( hPrinter );
+		ClosePrinter( hPrinter );
+		return FALSE;
+	}
+	// Send the data to the printer.
+	if( ! WritePrinter( hPrinter, lpData, dwCount, &dwBytesWritten ) )
+	{
+		GetErrorMessage( GetLastError(), TEXT("WritePrinter"), errMsg );
+		EndPagePrinter( hPrinter );
+		EndDocPrinter( hPrinter );
+		ClosePrinter( hPrinter );
+		return FALSE;
+	}
+	// End the page.
+	if( ! EndPagePrinter( hPrinter ) )
+	{
+		GetErrorMessage( GetLastError(), TEXT("EndPagePrinter"), errMsg );
+		EndDocPrinter( hPrinter );
+		ClosePrinter( hPrinter );
+		return FALSE;
+	}
+	// Inform the spooler that the document is ending.
+	if( ! EndDocPrinter( hPrinter ) )
+	{
+		GetErrorMessage( GetLastError(), TEXT("EndDocPrinter"), errMsg );
+		ClosePrinter( hPrinter );
+		return FALSE;
+	}
+	// Tidy up the printer handle.
+	ClosePrinter( hPrinter );
+	// Check to see if correct number of bytes were written.
+	if( dwBytesWritten != dwCount )
+	{
+		sprintf( errMsg, TEXT("Wrote %d bytes instead of requested %d bytes.\n"), dwBytesWritten, dwCount );
+		return FALSE;
+	}
+	return TRUE;
+}
+// End RawDataToPrinter
+// **********************************************************************

data/ext/raw_print.h

@@ -0,0 +1,2 @@
+BOOL GetPrinterNames(VALUE arr, char *errMsg);
+BOOL RawDataToPrinter( LPTSTR szPrinterName, LPBYTE lpData, DWORD dwCount, LPTSTR docName, char *errMsg );

data/lib/win_print.rb

@@ -0,0 +1,35 @@
+require "extension"
+require "win_print/version"
+
+# Ruby wrappers for native C functions.
+# Here we ensure correct encodings before calling C.
+module WinPrint
+  # Get list of printer names available on the system.
+  #
+  # Example:
+  #   >> WinPrint.get_printer_names
+  #   => ["Microsoft XPS Document Writer", "Microsoft Print to PDF", "Fax"]
+
+  def self.get_printer_names
+    WinPrint::Native.get_printer_names.map{|pr| pr.force_encoding("CP1252").encode("UTF-8")}
+  end
+
+  # Send raw data to a system printer.
+  #
+  # Example:
+  #   >> WinPrint.raw_print("Microsoft Print to PDF", "Some raw data.", "Test Job from WinPrint gem")
+  #   => true
+  #
+  # Arguments:
+  #   printer_name: (String)
+  #   data: (String) raw data to be sent to the printer
+  #   job_name: (String) will be displayed e.g. in the printer queue
+  #
+  # Note: For data, the encoding matters and the data will be sent as-is to the printer.
+  # Will raise RuntimeError if something goes wrong.
+
+  def self.raw_print(printer_name, data, job_name)
+    WinPrint::Native.raw_print(printer_name.encode("CP1252"), data,
+      job_name.encode("CP1252", invalid: :replace, undef: :replace, replace: ''))
+  end
+end

data/lib/win_print/version.rb

@@ -0,0 +1,3 @@
+module WinPrint
+  VERSION = "0.1.1"
+end

data/test/win_print_test.rb

@@ -0,0 +1,18 @@
+require "minitest/autorun"
+require "win_print"
+
+class WinPrintTest < Minitest::Test
+  def test_printer_names
+    # Just run the method and see if it dies (or hopefully not).
+    printers = WinPrint.get_printer_names
+    assert !printers.nil? # Should be an array.
+  end
+  
+  def test_printing_on_non_existing
+    # Try to print on a non-existing printer and verify, if we get the right exception.
+    exception = assert_raises RuntimeError do
+      WinPrint.raw_print("A printer with this name should definitely not exist.", "Some data.", "And a job name")
+    end
+    assert_includes exception.message, "[1801]"
+  end
+end

data/win_print.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "win_print/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "win_print"
+  spec.version       = WinPrint::VERSION
+  spec.authors       = ["Martin Schuster"]
+  spec.email         = "schuster@schul-logistik.de"
+  spec.homepage      = "http://github.com/mrschuster/win_print"
+  spec.license       = "MIT"
+  spec.summary       = "Gem for raw printing on windows"
+
+  spec.test_files    = Dir['test/*']
+  spec.extensions    = ["ext/extconf.rb"]
+  spec.files         = ['Rakefile', 'win_print.gemspec', 'Gemfile'] + Dir["ext/*.c", "ext/*.h", "ext/*.rb", "lib/**/*"]
+
+  spec.add_development_dependency "bundler", ">=1.16"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.description = <<-EOL
+    The WinPrint library offers a way to send raw data to
+    a system printer on windows. It also allows to fetch the
+    printer list.
+  EOL
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: win_print
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Martin Schuster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      The WinPrint library offers a way to send raw data to
+      a system printer on windows. It also allows to fetch the
+      printer list.
+email: schuster@schul-logistik.de
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- ext/extconf.rb
+- ext/extension.c
+- ext/raw_print.c
+- ext/raw_print.h
+- lib/win_print.rb
+- lib/win_print/version.rb
+- test/win_print_test.rb
+- win_print.gemspec
+homepage: http://github.com/mrschuster/win_print
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Gem for raw printing on windows
+test_files:
+- test/win_print_test.rb