ffi-cups 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2e82ad0fb30fa3e5c587658a3eef2af2044b3e06564e581c68e3b6d2d7e18db
+  data.tar.gz: c0f9f05991f788f5e4f2e10cf2e603fea2bb3eb45061d8318bd769e92be2b2f0
+SHA512:
+  metadata.gz: 4d1d560770915cf815dd32172d4707068401b9b7892babc5c3d099d99de7e10a567dd4a59a7543510f20d0a266361cf73b1e0abf23a971d04c4795d6be6d7c70
+  data.tar.gz: 6e3400f9edef9223e67fc46fbe4c51b1d7492c0e99d3a9e60360d3bb7745df9c6a79eb2d35ca7a805740dbe158f0848b3b4d4f2a3094ac140f1a7bb58ab49656

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/
+pkg/
+*.gem
+
+# YARD
+.yardopts
+.yardoc
+doc/*
+
+# Byebug
+.byebug_history

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ffi-cups.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'byebug'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ffi-cups (0.1.0)
+      ffi (~> 1.15.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.15.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  ffi-cups!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2021 Hugo Marquez & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# ffi-cups
+ffi-cups is a FFI wrapper around libcups providing access to the Cups API.
+It was written using Ruby 2.7.0.
+
+## About
+This is a complete rewrite of the cupsffi gem, it will deprecate
+functions deprecated by the CUPS API, if you wish to continue to use them,
+use the cupsffi gem.
+
+## Authors
+- Hugo Marquez @ www.hugomarquez.mx
+- Contributors @ https://github.com/hugomarquez/ffi-cups/graphs/contributors
+
+## Installation
+```bash
+gem install ffi-cups
+```
+
+## Setup
+ffi-cups requires libcups2 to be installed
+
+## TODO
+- send print jobs by creating the job itself first.
+
+## Example usage
+```ruby
+require 'ffi-cups'
+
+printers = Cups::Printer.get_destinations
+# [#<Cups::Printer:0x000055fe50b178e0 @name="HP_Officejet_J4500_series_ubuntu", @options={"device-uri"=>"ipps://HP%20Officejet%20J4500%20series%20%40%20ubuntu._ipps._tcp.local/cups", "printer-info"=>"HP Officejet J4500 series @ ubuntu", "printer-location"=>"", "printer-make-and-model"=>"HP Officejet j4585 All-in-one Printer", "printer-type"=>"16814110"}>, #<Cups::Printer:0x000055fe50b15798 @name="Virtual_PDF_Printer", @options={"copies"=>"1", "device-uri"=>"cups-pdf:/", "finishings"=>"3", "job-cancel-after"=>"10800", "job-hold-until"=>"no-hold", "job-priority"=>"50", "job-sheets"=>"none,none", "marker-change-time"=>"0", "number-up"=>"1", "printer-commands"=>"AutoConfigure,Clean,PrintSelfTestPage", "printer-info"=>"Virtual PDF Printer", "printer-is-accepting-jobs"=>"true", "printer-is-shared"=>"false", "printer-is-temporary"=>"false", "printer-location"=>"", "printer-make-and-model"=>"Generic CUPS-PDF Printer (w/ options)", "printer-state"=>"3", "printer-state-change-time"=>"1617884232", "printer-state-reasons"=>"none", "printer-type"=>"10547276", "printer-uri-supported"=>"ipp://localhost/printers/Virtual_PDF_Printer"}>]
+
+printer = Cups::Printer.get_destination("Virtual_PDF_Printer")
+#<Cups::Printer:0x0000560f1d4e0958 @name="Virtual_PDF_Printer", @options={"copies"=>"1", "device-uri"=>"cups-pdf:/", "finishings"=>"3", "job-cancel-after"=>"10800", "job-hold-until"=>"no-hold", "job-priority"=>"50", "job-sheets"=>"none,none", "marker-change-time"=>"0", "number-up"=>"1", "printer-commands"=>"AutoConfigure,Clean,PrintSelfTestPage", "printer-info"=>"Virtual PDF Printer", "printer-is-accepting-jobs"=>"true", "printer-is-shared"=>"false", "printer-is-temporary"=>"false", "printer-location"=>"", "printer-make-and-model"=>"Generic CUPS-PDF Printer (w/ options)", "printer-state"=>"3", "printer-state-change-time"=>"1617884232", "printer-state-reasons"=>"none", "printer-type"=>"10547276", "printer-uri-supported"=>"ipp://localhost/printers/Virtual_PDF_Printer"}> 
+
+```
+
+## Remote CUPS Server
+You may create a connection object passing a :hostname and/or :port arguments.
+
+You are in charge of the connection object, remember to close the 
+connection once you stop using it.
+
+```ruby
+# Create a Connection object with hostname and/or port
+connection = Cups::Connection.instance(hostname:'print.example.com')
+
+# Create a http pointer with CUPS API
+http = connection.httpConnect2
+
+# Get all printers from the remote connection
+remote_printers = Cups::Printer.get_destinations(http)
+
+# Close connection and release pointer
+Cups::Connection.close(http)
+```
+
+## License
+The MIT License
+
+Copyright (c) 2021 Hugo Marquez & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffi-cups"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ffi-cups.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/ffi-cups/version'
+
+Gem::Specification.new do |s|
+  s.name        = "ffi-cups"
+  s.version     = Cups::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Hugo Marquez", "Nathan Ehresman"]
+  s.email       = ["hugomarquez.dev@gmail.com"]
+  s.homepage    = "https://github.com/hugomarquez/ffi-cups"
+  s.summary     = "FFI wrapper around libcups"
+  s.description = "Simple wrapper around libcups to give CUPS printing capabilities to Ruby apps."
+  s.license     = "MIT"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  s.add_runtime_dependency "ffi", "~> 1.15.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  s.require_paths = ["lib"]
+end

data/lib/ffi-cups.rb

@@ -0,0 +1,39 @@
+require 'ffi'
+require 'byebug'
+
+module Cups
+  extend FFI::Library
+
+  begin
+    if ENV['CUPS_LIB']
+      ffi_lib(ENV['CUPS_LIB'])
+    else
+      ffi_lib('cups')
+    end
+  rescue LoadError => e
+    raise LoadError, "Didn't find libcups on your system."
+  end
+end
+
+# Constants
+require 'ffi-cups/constants'
+
+# Enums
+require 'ffi-cups/enum/http/status'
+# IPP
+require 'ffi-cups/enum/ipp/status'
+require 'ffi-cups/enum/ipp/job_state'
+
+# Structs
+require 'ffi-cups/struct/option'
+require 'ffi-cups/struct/destination'
+require 'ffi-cups/struct/job'
+
+# Functions
+require 'ffi-cups/ffi/cups'
+require 'ffi-cups/ffi/http'
+require 'ffi-cups/ffi/array'
+
+# wrappers
+require 'ffi-cups/connection'
+require 'ffi-cups/printer'

data/lib/ffi-cups/connection.rb

@@ -0,0 +1,57 @@
+module Cups
+  class Connection
+    extend Gem::Deprecate
+
+    attr_accessor :hostname, :port
+    
+    @instance_mutex = Mutex.new
+
+    private_class_method :new
+
+    def initialize(args={})
+      @hostname = args.fetch(:hostname) { Cups::CUPS_HTTP_DEFAULT }
+      @port = args.fetch(:port) { 631 }
+    end
+
+    # Returns or creates a singleton instance
+    # @param args [Hash] hash argument with hostname and port
+    # @return [Object] a connection object
+    def self.instance(args)
+      return @instance if @instance
+
+      @instance_mutex.synchronize do 
+        @instance ||= new(args)
+      end
+
+      @instance
+    end
+    
+    # Wrapper around {::FFI::Cups::Http#httpConnectEncrypt}
+    # @deprecated Use {#httpConnect2} instead
+    # @return [Pointer] a http pointer 
+    def httpConnectEncrypt
+      http = FFI::Cups::Http.httpConnectEncrypt(hostname, port, FFI::Cups.cupsEncryption())
+      raise "Print server at #{hostname}:#{port} is not available" if http.null?
+      return http
+    end
+    deprecate :httpConnectEncrypt, "This function is deprecated by CUPS, please use httpConnect2 instead", 2025, 12
+
+    # Wrapper around {::FFI::Cups::Http#httpConnect2}
+    # Creates a http connection to a print server
+    # @return [Pointer] a http pointer
+    def httpConnect2
+      http = FFI::Cups::Http.httpConnect2(hostname, port, nil, 0, FFI::Cups.cupsEncryption(), 1, 30000, nil)
+      raise "Print server at #{hostname}:#{port} is not available" if http.null? 
+      return http
+    end
+
+    # Closes the http connection and autoreleases the pointer
+    # Wrapper around {::FFI::Cups::Http#httpClose}
+    # @param http (Pointer)
+    def self.close(http)
+      FFI::Cups::Http.httpClose(pointer)
+      pointer.autorelease = true
+    end
+  end
+end
+

data/lib/ffi-cups/constants.rb

@@ -0,0 +1,95 @@
+module Cups
+  # cups.h
+  CUPS_FORMAT_JPEG		      = "image/jpeg"
+  CUPS_FORMAT_PDF		        = "application/pdf"
+  CUPS_FORMAT_TEXT		      = "text/plain"
+  CUPS_JOBID_ALL            = -1
+  CUPS_WHICHJOBS_ALL        = -1
+  CUPS_WHICHJOBS_ACTIVE     = 0
+  CUPS_WHICHJOBS_COMPLETED  = 1
+  CUPS_HTTP_DEFAULT         = nil
+
+  # Options and Values
+  CUPS_COPIES               = "copies"
+  CUPS_COPIES_SUPPORTED     = "copies-supported"
+
+  CUPS_FINISHINGS           = "CUPS_FINISHINGS"
+  CUPS_FINISHINGS_SUPPORTED = "finishings-supported"
+
+  CUPS_FINISHINGS_BIND		  = "7"
+  CUPS_FINISHINGS_COVER		  = "6"
+  CUPS_FINISHINGS_FOLD		  = "10"
+  CUPS_FINISHINGS_NONE		  = "3"
+  CUPS_FINISHINGS_PUNCH		  = "5"
+  CUPS_FINISHINGS_STAPLE	  = "4"
+  CUPS_FINISHINGS_TRIM		  = "11"
+  
+  CUPS_MEDIA			          = "media"
+  CUPS_MEDIA_READY		      = "media-ready"
+  CUPS_MEDIA_SUPPORTED		  = "media-supported"
+
+  CUPS_MEDIA_3X5		        = "na_index-3x5_3x5in"
+  CUPS_MEDIA_4X6	  	      = "na_index-4x6_4x6in"
+  CUPS_MEDIA_5X7		        = "na_5x7_5x7in"
+  CUPS_MEDIA_8X10		        = "na_govt-letter_8x10in"
+  CUPS_MEDIA_A3			        = "iso_a3_297x420mm"
+  CUPS_MEDIA_A4		          = "iso_a4_210x297mm"
+  CUPS_MEDIA_A5			        = "iso_a5_148x210mm"
+  CUPS_MEDIA_A6			        = "iso_a6_105x148mm"
+  CUPS_MEDIA_ENV10		      = "na_number-10_4.125x9.5in"
+  CUPS_MEDIA_ENVDL		      = "iso_dl_110x220mm"
+  CUPS_MEDIA_LEGAL	        = "na_legal_8.5x14in"
+  CUPS_MEDIA_LETTER		      = "na_letter_8.5x11in"
+  CUPS_MEDIA_PHOTO_L		    = "oe_photo-l_3.5x5in"
+  CUPS_MEDIA_SUPERBA3		    = "na_super-b_13x19in"
+  CUPS_MEDIA_TABLOID		    = "na_ledger_11x17in"
+
+  CUPS_MEDIA_SOURCE		        = "media-source"
+  CUPS_MEDIA_SOURCE_SUPPORTED	= "media-source-supported"
+
+  CUPS_MEDIA_SOURCE_AUTO	  = "auto"
+  CUPS_MEDIA_SOURCE_MANUAL	= "manual"
+
+  CUPS_MEDIA_TYPE		        = "media-type"
+  CUPS_MEDIA_TYPE_SUPPORTED	= "media-type-supported"
+
+  CUPS_MEDIA_TYPE_AUTO		      = "auto"
+  CUPS_MEDIA_TYPE_ENVELOPE	    = "envelope"
+  CUPS_MEDIA_TYPE_LABELS	      = "labels"
+  CUPS_MEDIA_TYPE_LETTERHEAD	  = "stationery-letterhead"
+  CUPS_MEDIA_TYPE_PHOTO		      = "photographic"
+  CUPS_MEDIA_TYPE_PHOTO_GLOSSY	= "photographic-glossy"
+  CUPS_MEDIA_TYPE_PHOTO_MATTE	  = "photographic-matte"
+  CUPS_MEDIA_TYPE_PLAIN		      = "stationery"
+  CUPS_MEDIA_TYPE_TRANSPARENCY	= "transparency"
+
+  CUPS_NUMBER_UP		        = "number-up"
+  CUPS_NUMBER_UP_SUPPORTED	= "number-up-supported"
+
+  CUPS_ORIENTATION		        = "orientation-requested"
+  CUPS_ORIENTATION_SUPPORTED	= "orientation-requested-supported"
+
+  CUPS_ORIENTATION_PORTRAIT	  = "3"
+  CUPS_ORIENTATION_LANDSCAPE	= "4"
+
+  CUPS_PRINT_COLOR_MODE		        = "print-color-mode"
+  CUPS_PRINT_COLOR_MODE_SUPPORTED = "print-color-mode-supported"
+
+  CUPS_PRINT_COLOR_MODE_AUTO	      = "auto"
+  CUPS_PRINT_COLOR_MODE_MONOCHROME  = "monochrome"
+  CUPS_PRINT_COLOR_MODE_COLOR	      = "color"
+
+  CUPS_PRINT_QUALITY		        = "print-quality"
+  CUPS_PRINT_QUALITY_SUPPORTED	= "print-quality-supported"
+
+  CUPS_PRINT_QUALITY_DRAFT	= "3"
+  CUPS_PRINT_QUALITY_NORMAL	= "4"
+  CUPS_PRINT_QUALITY_HIGH   = "5"
+
+  CUPS_SIDES			      = "sides"
+  CUPS_SIDES_SUPPORTED	=	"sides-supported"
+
+  CUPS_SIDES_ONE_SIDED		        = "one-sided"
+  CUPS_SIDES_TWO_SIDED_PORTRAIT	  = "two-sided-long-edge"
+  CUPS_SIDES_TWO_SIDED_LANDSCAPE  = "two-sided-short-edge"
+end

data/lib/ffi-cups/enum/http/status.rb

@@ -0,0 +1,50 @@
+module Cups::Enum
+  module HTTP
+    extend FFI::Library
+
+    Status = enum [
+      :http_error, -1,
+      :http_continue, 100,
+      :http_switching_protocols,
+      :http_ok, 200,
+      :http_created,
+      :http_accepted,
+      :http_not_authoritative,
+      :http_no_content,
+      :http_reset_content,
+      :http_partial_content,
+      :http_multiple_choices, 300,
+      :http_moved_permanently,
+      :http_moved_temporarily,
+      :http_see_other,
+      :http_not_modified,
+      :http_use_proxy,
+      :http_bad_request, 400,
+      :http_unauthorized,
+      :http_payment_required,
+      :http_forbidden,
+      :http_not_found,
+      :http_method_not_allowed,
+      :http_not_acceptable,
+      :http_proxy_authentication,
+      :http_request_timeout,
+      :http_conflict,
+      :http_gone,
+      :http_length_required,
+      :http_precondition,
+      :http_request_too_large,
+      :http_uri_too_long,
+      :http_unsupported_mediatype,
+      :http_requested_range,
+      :http_expectation_failed,
+      :http_upgrade_required, 426,
+      :http_server_error, 500,
+      :http_not_implemented,
+      :http_bad_gateway,
+      :http_service_unavailable,
+      :http_gateway_timeout,
+      :http_not_supported,
+      :http_authorization_canceled, 1000
+    ]
+  end
+end

data/lib/ffi-cups/enum/ipp/job_state.rb

@@ -0,0 +1,15 @@
+module Cups::Enum
+  module IPP
+    extend FFI::Library
+    
+    JobState = enum [
+      :pending, 3,
+      :held,
+      :processing,
+      :stopped,
+      :canceled,
+      :aborted,
+      :completed
+    ]
+  end
+end

data/lib/ffi-cups/enum/ipp/status.rb

@@ -0,0 +1,53 @@
+module Cups::Enum
+  module IPP
+    extend FFI::Library
+
+    Status = enum [
+      :ipp_ok, 0,
+      :ipp_ok_subst,
+      :ipp_ok_conflict,
+      :ipp_ok_ignored_subscriptions,
+      :ipp_ok_ignored_notifications,
+      :ipp_ok_too_many_events,
+      :ipp_ok_but_cancel_subscription,
+      :ipp_ok_events_complete,
+      :ipp_redirection_other_site, 512,
+      :cups_see_other, 640,
+      :ipp_bad_request, 1024,
+      :ipp_forbidden,
+      :ipp_not_authenticated,
+      :ipp_not_authorized,
+      :ipp_not_possible,
+      :ipp_timeout,
+      :ipp_not_found,
+      :ipp_gone,
+      :ipp_request_entity,
+      :ipp_request_value,
+      :ipp_document_format,
+      :ipp_attributes,
+      :ipp_uri_scheme,
+      :ipp_charset,
+      :ipp_conflict,
+      :ipp_compression_not_supported,
+      :ipp_compression_error,
+      :ipp_document_format_error,
+      :ipp_document_access_error,
+      :ipp_attributes_not_settable,
+      :ipp_ignored_all_subscriptions,
+      :ipp_too_many_subscriptions,
+      :ipp_ignored_all_notifications,
+      :ipp_print_support_file_not_found,
+      :ipp_internal_error, 1280,
+      :ipp_operation_not_supported,
+      :ipp_service_unavailable,
+      :ipp_version_not_supported,
+      :ipp_device_error,
+      :ipp_temporary_error,
+      :ipp_not_accepting,
+      :ipp_printer_busy,
+      :ipp_error_job_canceled,
+      :ipp_multiple_jobs_not_supported,
+      :ipp_printer_is_deactivated
+    ]
+  end
+end

data/lib/ffi-cups/ffi/array.rb

@@ -0,0 +1,17 @@
+module FFI::Cups
+  module Array
+    extend FFI::Library
+    
+    ffi_lib('cups')
+    
+    # @overload cupsArrayFirst(pointer)
+    #   @param pointer [Pointer] to _cups_array_s struct
+    #   @return [Pointer] void pointer to first element
+    attach_function 'cupsArrayFirst', [:pointer], :pointer, blocking: true
+
+    # @overload cupsArrayNext(pointer)
+    #   @param pointer [Pointer] to _cups_array_s struct
+    #   @return [Pointer] void pointer to first element
+    attach_function 'cupsArrayNext', [:pointer], :pointer, blocking: true
+  end
+end

data/lib/ffi-cups/ffi/cups.rb

@@ -0,0 +1,176 @@
+# cups.h
+# {https://www.cups.org/doc/cupspm.html Programming Manual}
+# {https://github.com/apple/cups/blob/master/cups/cups.h cups.h source}
+
+module FFI::Cups
+  extend FFI::Library
+
+  ffi_lib('cups')
+  
+  # Get the current encryption settings.
+  # @return [Integer] encryption settings
+  # {https://www.cups.org/doc/cupspm.html#cupsEncryption}
+  attach_function 'cupsEncryption', [], :int, blocking: true
+
+  # Check that the option and value are supported by the destination.
+  # @overload cupsCheckDestSupported(pointer, pointer, pointer, string, string)
+  #   @param http [Pointer]
+  #   @param destination [Pointer]
+  #   @param dinfo [Pointer]
+  #   @param option [String]
+  #   @param value [String]
+  #   @return [Integer] 1 if supported, 0 otherwise
+  # {https://www.cups.org/doc/cupspm.html#cupsCheckDestSupported}
+  attach_function 'cupsCheckDestSupported', [:pointer, :pointer, :pointer, :string, :string], :int, blocking: true
+
+  # Get the named destination from the list.
+  # @overload cupsGetDest(string, string, int, pointer)
+  #   @param name [String]
+  #   @param instance [String] instance name or NULL
+  #   @param num_dests [Integer] number of destinations
+  #   @param destinations [Pointer]
+  #   @return [Pointer, NULL] destination or NULL
+  # {https://www.cups.org/doc/cupspm.html#cupsGetDest}
+  attach_function 'cupsGetDest', [:string, :string, :int, :pointer], :pointer, blocking: true
+
+  # Get the list of destinations from the specified server.
+  # @overload cupsGetDests2(pointer, pointer)
+  #   @param pointer [Pointer] to http connection for server or CUPS_HTTP_DEFAULT
+  #   @param pointer [Pointer] to destinations
+  #   @return [Integer] number of destinations
+  # {https://www.cups.org/doc/cupspm.html#cupsGetDests2}
+  attach_function 'cupsGetDests2', [:pointer, :pointer], :int, blocking: true
+
+  # Free the memory used by the list of destinations.
+  # @overload cupsFreeDests(int, pointer)
+  #   @param number [Integer] of destinations
+  #   @param pointer [Pointer] to destinations
+  # {https://www.cups.org/doc/cupspm.html#cupsFreeDests}
+  attach_function 'cupsFreeDests', [ :int, :pointer ], :void, blocking: true
+
+  # Prints a File
+  # @overload cupsPrintFile(string, string, string, int, pointer)
+  #   @param name [String] of the printer
+  #   @param name [String] of the file
+  #   @param title [String] of the job
+  #   @param number [Integer] of options
+  #   @param pointer [Pointer] to a CupsOptionS struct
+  #   @return [Integer] job number or 0 on error
+  attach_function 'cupsPrintFile', [ :string, :string, :string, :int, :pointer ], :int, blocking: true
+  
+  # Prints a file from a specific connection
+  # @overload cupsPrintFile2(pointer, string, string, string, int, pointer)
+  #   @param pointer [Pointer] to an http connection
+  #   @param name [String] of the printer
+  #   @param name [String] of the file
+  #   @param title [String] of the title
+  #   @param number [Integer] of options
+  #   @param pointer [Pointer] to a CupsOptionS struct
+  #   @return [Integer] number of the job or 0 on error
+  attach_function 'cupsPrintFile2', [ :pointer, :string, :string, :string, :int, :pointer ], :int, blocking: true
+
+  # Returns the last error in string format
+  # @return [String] error
+  attach_function 'cupsLastErrorString', [], :string, blocking: true
+
+  # Cancel a job on a destination.
+  # @overload cupsCancelDestJob(string, int)
+  #   @param connection [Pointer] to a http server
+  #   @param pointer [Pointer] to a destination
+  #   @param id [Integer] of the job
+  #   @return [Integer] IPP status
+  # {https://www.cups.org/doc/cupspm.html#cupsCancelDestJob}
+  attach_function 'cupsCancelDestJob', [:string, :int], :void, blocking: true
+
+  # Cancel a job on a destination name
+  # @overload cupsCancelJob(string, int)
+  #   @param name [String] of the destination
+  #   @param id [Ingeger] of the job
+  attach_function 'cupsCancelJob', [:string, :int], :void, blocking: true
+
+  # Cancel a job on a destination
+  # @overload cupsCancelJob2(pointer, string, int)
+  #   @param pointer [Pointer] of the http connection
+  #   @param name [String] of the destination
+  #   @param id [Ingeger] of the job
+  attach_function 'cupsCancelJob2', [:pointer, :string, :int], :void, blocking: true
+
+  # Get the jobs from a connection
+  # @overload cupsGetJobs2(pointer, pointer, string, int, int)
+  #   @param pointer [Pointer] to a http connection object
+  #   @param pointer [Pointer] to Cups::Struct::Job
+  #   @param name [String] of the printer
+  #   @param number [Integer] of type of job (0 == all users, 1 == mine)
+  #   @param which [Integer] jobs (CUPS_WHICHJOBS_ALL, CUPS_WHICHJOBS_ACTIVE, or CUPS_WHICHJOBS_COMPLETED)
+  #   @return [Integer] number of jobs
+  # {https://www.cups.org/doc/cupspm.html#cupsGetJobs2}
+  attach_function 'cupsGetJobs2', [:pointer, :pointer, :string, :int, :int], :int, blocking: true
+
+  # Get the jobs
+  # @overload cupsGetJobs(pointer, string, int, int)
+  #   @param pointer [Pointer] to Cups::Struct::Job to populate
+  #   @param name [String] of the printer
+  #   @param number [Integer] of type of job (0 == all users, 1 == mine)
+  #   @param which [Integer] jobs (CUPS_WHICHJOBS_ALL, CUPS_WHICHJOBS_ACTIVE, or CUPS_WHICHJOBS_COMPLETED)
+  #   @return [Integer] number of jobs
+  attach_function 'cupsGetJobs', [:pointer, :string, :int, :int], :int, blocking: true
+
+  # Free memory used by job data.
+  # @overload cupsFreeJobs(int, pointer)
+  #   @param number [Integer] of jobs
+  #   @param pointer [Pointer] to the first Cups::Struct::Job to free
+  # {https://www.cups.org/doc/cupspm.html#cupsFreeJobs}
+  attach_function 'cupsFreeJobs', [:int, :pointer ], :void, blocking: true
+
+  # Create a job on a destination.
+  # @overload cupsCreateJob(pointer, string, string, int, pointer)
+  #   @param pointer [Pointer] to http connection to server or CUPS_HTTP_DEFAULT
+  #   @param name [String] of the printer
+  #   @param title [String] of the job
+  #   @param number [Integer] of options
+  #   @param pointer [Pointer] to a Cups::Struct::Option object
+  #   @return [Integer] job number or 0 on error
+  attach_function 'cupsCreateJob', [:pointer, :string, :string, :int, :pointer], :int, blocking: true
+
+  # Start a document
+  # @overload cupsStartDocument(pointer, string, int, string, string, int)
+  #   @param pointer [Pointer] to http connection to server or CUPS_HTTP_DEFAULT
+  #   @param name [String] of the printer
+  #   @param id [Integer] of the job
+  #   @param name [String] of the document
+  #   @param mime_type [String] format of the document
+  #   @param number [Integer] of the last document (1 for last document in job, 0 otherwise)
+  #   @return [Cups::Enum::HTTP::Status] HttpStatus
+  # {https://www.cups.org/doc/cupspm.html#submitting-a-print-job}
+  attach_function 'cupsStartDocument', [:pointer, :string, :int, :string, :string, :int], Cups::Enum::HTTP::Status, blocking: true
+
+  # @overload cupsWriteRequestData(pointer, pointer, bytesize)
+  #   @param pointer [Pointer] to http connection to server or CUPS_HTTP_DEFAULT
+  #   @param data [Pointer] in a character string pointer
+  #   @param length [Byte] of data
+  #   @return [Cups::Enum::HTTP::Status] HttpStatus
+  attach_function 'cupsWriteRequestData', [:pointer, :pointer, :size_t], Cups::Enum::HTTP::Status, blocking: true
+
+  # @overload cupsFinishDocument(pointer, string)
+  #   @param pointer [Pointer] to http connection to server or CUPS_HTTP_DEFAULT
+  #   @param name [String] of the printer
+  #   @return [Cups::Enum::IPP::Status] IppStatus
+  attach_function 'cupsFinishDocument', [:pointer, :string], Cups::Enum::IPP::Status, blocking: true
+
+  # Add an option to an option array.
+  # @overload cupsAddOption(string, string, int, pointer)
+  #   @param name [String] of option
+  #   @param value [String] of option
+  #   @param number [Integer] of options
+  #   @param pointer [Pointer] to options
+  #   @return [Integer] number of options
+  # {https://www.cups.org/doc/cupspm.html#cupsAddOption}
+  attach_function 'cupsAddOption', [:string, :string, :int, :pointer], :int, blocking: true
+
+  # Free all memory used by options.
+  # @overload cupsFreeOptions(int, pointer)
+  #   @param number [Integer] of options
+  #   @param pointer [Pointer] to options
+  # {https://www.cups.org/doc/cupspm.html#cupsFreeOptions}
+  attach_function 'cupsFreeOptions', [:int, :pointer], :void, blocking: true
+end

data/lib/ffi-cups/ffi/http.rb

@@ -0,0 +1,40 @@
+module FFI::Cups
+  module Http
+    extend FFI::Library
+
+    ffi_lib('cups')
+
+    # @overload httpConnectEncrypt(string, int, int)
+    #   @param hostname [String]
+    #   @param port [int]
+    #   @param encryption_settings [int]
+    #   @return [Pointer] pointer to a http_t object
+    # @deprecated Please use httpConnect2 instead
+    attach_function 'httpConnectEncrypt', [ :string, :int, :int], :pointer, blocking: true
+
+    # @overload httpClose(pointer)
+    #   @param pointer [Pointer] to a http_t object
+    attach_function 'httpClose', [ :pointer ], :void, blocking: true
+
+    # Get a list of addresses for a hostname.
+    # @overload httpAddrGetList(string, int, string)
+    #   @param hostname [String]
+    #   @param family [Integer]
+    #   @param port [String]
+    #   @return [Pointer] List of addresses or NULL
+    attach_function 'httpAddrGetList', [:string, :int, :string], :pointer, blocking: true
+
+    # Connect to a HTTP server.
+    # @overload httpConnect2(string, int, pointer, int, int, int, int, pointer)
+    #   @param hostname [String]
+    #   @param port [Integer]
+    #   @param addrlist [Pointer] can be NULL
+    #   @param family [Integer] (AF_UNSPEC=0)
+    #   @param encryption_settings [Integer] from FFI::Cups.cupsEncryption()
+    #   @param blocking [Integer]
+    #   @param msec [Integer] use 5000 or less
+    #   @param cancel[Pointer] integer pointer, can be NULL
+    #   @return [Pointer] http_t object
+    attach_function 'httpConnect2', [:string, :int, :pointer, :int, :int, :int, :int, :pointer], :pointer, blocking: true
+  end
+end

data/lib/ffi-cups/job.rb

@@ -0,0 +1,13 @@
+module Cups
+  class Job
+    attr_accessor :id, :title, :printer
+
+    def initialize(id, title, printer=nil)
+      @id = id
+      @title = title
+      @printer = printer
+    end
+
+  end
+end
+

data/lib/ffi-cups/printer.rb

@@ -0,0 +1,105 @@
+module Cups
+  class Printer
+    attr_reader :name, :options
+
+    # @param name [String] printer's name
+    # @param options [Hash] printer's options
+    def initialize(name, options={})
+      @name = name
+      @options = options
+    end
+
+    # Returns the printer state
+    # @return [Symbol] printer state from options
+    def state
+      case options['printer-state']
+      when '3' then :idle
+      when '4' then :printing
+      when '5' then :stopped
+      else :unkown
+      end
+    end
+
+    # Returns the reason for the printer state
+    # @return [Array] array of reasons in string format
+    def state_reasons
+      options['printer-state-reasons'].split(/,/)
+    end
+
+    # Get all destinations (printer devices)
+    # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
+    def self.get_destinations(connection=nil)
+      pointer = FFI::MemoryPointer.new :pointer
+      destinations = cupsGetDests2(connection, pointer)
+      printers = []
+      destinations.each do |k, d|
+        destination_opt = cupsOptions(d)
+        options = {}
+
+        destination_opt.each do |k, o|
+          options[o[:name].dup] = o[:value].dup
+        end
+
+        printer = Cups::Printer.new(d[:name].dup, options)
+        printers.push(printer)
+      end
+      cupsFreeDests(destinations.keys.count, pointer)
+      return printers
+    end
+
+    # Get a destination by name
+    # @param name [String] name of the printer
+    # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
+    def self.get_destination(name, connection=nil)
+      printers = get_destinations(connection)
+      printers.each do |p|
+        return p if p.name == name
+      end
+      raise "Destination with name: #{name} not found!" 
+    end
+
+    private
+    # Wrapper around {::FFI::Cups#cupsGetDests2}
+    # @param connection [Pointer] http pointer from {Cups::Connection#httpConnect2}
+    # @param pointer [Pointer] pointer to the destinations
+    # @return [Hash] hashmap of destination structs
+    def self.cupsGetDests2(connection=nil, pointer)
+      count_destinations = FFI::Cups.cupsGetDests2(connection, pointer)
+      struct_size = Cups::Struct::Destination.size
+      destinations = {}
+      count_destinations.times do |index|
+        destination = Cups::Struct::Destination.new(pointer.get_pointer(0) + (struct_size * index))
+        destinations[index] = destination
+      end
+      return destinations
+    end
+
+    # Returns a destination's options
+    # @param destination [Object] {Cups::Struct::Destination} object
+    # @return [Hash] hashmap of destination' options as {Cups::Struct::Option}
+    def self.cupsOptions(destination)
+      struct_size = Cups::Struct::Option.size
+      options = {}
+
+      destination[:num_options].times do |index|
+        option = Cups::Struct::Option.new(destination[:options] + (struct_size * index))
+        options[index] = option
+      end
+      return options
+    end
+
+    # Wrapper around {::FFI::Cups#cupsFreeDests}
+    # @param number_destinations [Integer]
+    # @param pointer [Pointer] pointer to the destinations
+    def self.cupsFreeDests(number_destinations, pointer)
+      FFI::Cups.cupsFreeDests(number_destinations, pointer.get_pointer(0))
+    end
+
+    # Wrapper around {::FFI::Cups#cupsFreeOptions}
+    # @param number_options [Integer]
+    # @param pointer [Pointer] pointer to the options
+    def self.cupsFreeOptions(number_options, pointer)
+      FFI::Cups.cupsFreeOptions(number_options, pointer.get_pointer(0))
+    end
+  end
+end

data/lib/ffi-cups/struct/destination.rb

@@ -0,0 +1,9 @@
+module Cups::Struct
+  class Destination < FFI::Struct
+    layout  :name,        :string,
+            :instance,    :string,
+            :is_default,  :int,
+            :num_options, :int,
+            :options,     :pointer
+  end
+end

data/lib/ffi-cups/struct/job.rb

@@ -0,0 +1,15 @@
+module Cups::Struct
+  class Job < FFI::Struct
+    layout  :id,                :int,
+            :dest,              :string,
+            :title,             :string,
+            :user,              :string,
+            :format,            :string,
+            :state,             Cups::Enum::IPP::JobState,
+            :size,              :int,
+            :priority,          :int,
+            :completed_time,    :long,
+            :creation_time,     :long,
+            :processing_time,   :long
+  end
+end

data/lib/ffi-cups/struct/option.rb

@@ -0,0 +1,5 @@
+module Cups::Struct
+  class Option < FFI::Struct
+    layout  :name, :string, :value, :string
+  end
+end

data/lib/ffi-cups/version.rb

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ffi-cups
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hugo Marquez
+- Nathan Ehresman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+description: Simple wrapper around libcups to give CUPS printing capabilities to Ruby
+  apps.
+email:
+- hugomarquez.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ffi-cups.gemspec
+- lib/ffi-cups.rb
+- lib/ffi-cups/connection.rb
+- lib/ffi-cups/constants.rb
+- lib/ffi-cups/enum/http/status.rb
+- lib/ffi-cups/enum/ipp/job_state.rb
+- lib/ffi-cups/enum/ipp/status.rb
+- lib/ffi-cups/ffi/array.rb
+- lib/ffi-cups/ffi/cups.rb
+- lib/ffi-cups/ffi/http.rb
+- lib/ffi-cups/job.rb
+- lib/ffi-cups/printer.rb
+- lib/ffi-cups/struct/destination.rb
+- lib/ffi-cups/struct/job.rb
+- lib/ffi-cups/struct/option.rb
+- lib/ffi-cups/version.rb
+homepage: https://github.com/hugomarquez/ffi-cups
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: FFI wrapper around libcups
+test_files: []