ffi-cups 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd36e5fc525b811e3fedc0ef3b015aa47e04cf93528510a539ae3562a0e0357
-  data.tar.gz: ca00e58337c11b4291dc1debd2908e21e3bb772d4127779fc28937043fd77aa6
+  metadata.gz: 63c1079a34a2ba53dd1ba0a0be14738700cfc17540ebfffd517674bfe67c9525
+  data.tar.gz: c6bd62d2efc4bce337b774becb392012c899cc345ed7df8fb34b4548d3f53c85
 SHA512:
-  metadata.gz: 2f751bb3648d4b66926dc962a469f6446de032c0d309892ff8defae327051c5425bdb54ad7bf52f557e11d4f03e120269abc63b17a0091ac47652042e6350bfa
-  data.tar.gz: 5726071fba04a620382afc78954c3f0790c496befdecc0cad3a3c8327cf440c4fd9f68e03a96d695fa6c2ef737bbcdb709f49cbe89889feb7eaa20292b1c2f14
+  metadata.gz: 23e2d001e8eb819b52940584b984bedd4f380ff5d41b0fcff97abd36168ffe561dc611ce8e3d1f21ccb70f47c00ef05e381f001493a8dca159ce43f3d55723ea
+  data.tar.gz: e31273be32df34f501b27542b894c7bd73b34cbd18a93af65466a27d3184a0c96e76d10b598f3737215e1634c38eca32c68c762224cc41ead11c317056a547fb

data/README.md

@@ -1,31 +1,18 @@
-# ffi-cups
+# FFI-Cups
 [![Gem Version](https://badge.fury.io/rb/ffi-cups.svg)](https://badge.fury.io/rb/ffi-cups)
 
-ffi-cups is a FFI wrapper around libcups providing access to the Cups API.
-It was written using Ruby 2.7.0.
+This gem ffi-cups is a FFI bindings for libcups providing access to the Cups API through Ruby.
 
-## 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
+CUPS is the standards-based, open source printing system developed by Apple Inc. for macOS® and other UNIX®-like operating systems. CUPS uses the Internet Printing Protocol (IPP) to support printing to local and network printers. - from http://www.cups.org/
 
 ## Installation
 ```bash
 gem install ffi-cups
 ```
 
-## Setup
+## Setup & Requirements
 ffi-cups requires libcups2 to be installed
 
-## TODO
-- Job's state
-- Cancel jobs
-- Get all jobs with filters
-
 ## Example usage
 ```ruby
 require 'ffi-cups'
@@ -53,7 +40,18 @@ options = {
 }
 
 job = printer.print_file('/tmp/example.jpg', 'Title', options)
+# <Cups::Job:0x000055c87104d1e0 @id=10, @title="README", @printer="Virtual_PDF_Printer", @format="text/plain", @state=:processing, @size=4, @completed_time=1969-12-31 18:00:00 -0600, @creation_time=2021-04-18 17:35:04 -0500, @processing_time=2021-04-18 17:35:04 -0500> 
+
+# Get all jobs from a printer
+jobs = Cups::Job.get_jobs('Virtual_PDF_Printer')
+# [#<Cups::Job:0x0000563aa6359008 @id=1, @title="Test Print", @printer="Virtual_PDF_Printer", @format="text/plain", @state=:completed, @size=1, @completed_time=2021-04-08 07:06:23 -0500, @creation_time=2021-04-08 07:06:18 -0500, @processing_time=2021-04-08 07:06:18 -0500>, ...]
+
+# filtering job's query, see Constants file for more options
+jobs = Cups::Job.get_jobs('Virtual_PDF_Printer', Cups::CUPS_WHICHJOBS_ACTIVE)
 
+# Query job with id and printer's name
+job = Cups::Job.get_job(10, 'Virtual_PDF_Printer')
+# <Cups::Job:0x000055c870fc8490 @id=10, @title="README", @printer="Virtual_PDF_Printer", @format="text/plain", @state=:completed, @size=4, @completed_time=2021-04-18 17:35:04 -0500, @creation_time=2021-04-18 17:35:04 -0500, @processing_time=2021-04-18 17:35:04 -0500>
 ```
 
 ## Remote CUPS Server
@@ -61,13 +59,23 @@ You may create a connection object passing a :hostname and/or :port arguments.
 
 ```ruby
 # Create a Connection object with hostname and/or port
-connection = Cups::Connection.instance('print.example.com')
+connection = Cups::Connection.new('print.example.com')
 
 # Get all printers from the remote connection
 remote_printers = Cups::Printer.get_destinations(connection)
-
 ```
 
+## Documentation
+Check out the documentation - [docs](https://www.rubydoc.info/gems/ffi-cups/0.1.9)
+
+## TODO
+- Connection to not be a singleton class
+- Cancel jobs function
+
+## Authors
+- Hugo Marquez @ www.hugomarquez.mx
+- Contributors @ https://github.com/hugomarquez/ffi-cups/graphs/contributors
+
 ## License
 The MIT License
 

data/lib/ffi-cups/connection.rb

@@ -3,30 +3,12 @@ module Cups
     extend Gem::Deprecate
 
     attr_accessor :hostname, :port
-    
-    @instance_mutex = Mutex.new
-
-    private_class_method :new
 
     def initialize(hostname, port=nil)
       @hostname = hostname
       @port = port.nil? ? 631 : port
     end
-
-    # Returns or creates a singleton instance
-    # @param hostname [String]
-    # @param port [Integer]
-    # @return [Object] a connection object
-    def self.instance(hostname, port=nil)
-      return @instance if @instance
-
-      @instance_mutex.synchronize do 
-        @instance ||= new(hostname, port)
-      end
-
-      @instance
-    end
-    
+        
     # Wrapper around {::FFI::Cups::Http#httpConnectEncrypt}
     # @deprecated Use {#httpConnect2} instead
     # @return [Pointer] a http pointer 

data/lib/ffi-cups/job.rb

@@ -1,11 +1,71 @@
 module Cups
   class Job
-    attr_reader :id, :title, :printer
-    def initialize(id, title, printer=nil)
+    attr_accessor :id, :title, :printer,
+      :format, :state, :size, :completed_time,
+      :creation_time, :processing_time
+
+    def initialize(id, title, printer)
       @id = id
       @title = title
       @printer = printer
     end
+
+    # Get jobs by filter or destination name
+    # @param name [String]
+    # @param filter [Integer] see Constants
+    # @param connection [Cups::Connection]
+    # @return [Array] jobs
+    def self.get_jobs(name=nil, filter=-1, connection=nil)
+      p_jobs = FFI::MemoryPointer.new :pointer
+      cups_jobs = cupsGetJobs2(p_jobs, name, filter, connection)
+      jobs = []
+      cups_jobs.each do |j|
+        job = Cups::Job.new(j[:id].dup, j[:title].dup, j[:dest].dup)
+        job.format = j[:format]
+        job.state = j[:state]
+        job.size = j[:size]
+        job.completed_time = Time.at(j[:completed_time])
+        job.creation_time = Time.at(j[:creation_time])
+        job.processing_time = Time.at(j[:processing_time])
+        jobs.push(job)
+      end
+      return jobs
+    end
+
+    # Get job from id
+    # @param id [Integer]
+    # @param name [String]
+    # @param filter [Integer] see Constants
+    # @param connection [Cups::Connection]
+    # @return [Job] job object
+    def self.get_job(id, name=nil, filter=-1, connection=nil)
+      jobs = get_jobs(name, filter, connection)
+      jobs.each do |j|
+        return j if j.id == id
+      end
+    end
+
+    private
+    # Wrapper {::FFI::Cups#cupsGetJobs2}
+    # @param pointer [Pointer] pointer to the jobs
+    # @param name [String] name of the destination or NULL
+    # @param filter [Integer] see Constants for more filters
+    # @param connection [Cups::Connection]
+    # @return [Array] array of job structs
+    def self.cupsGetJobs2(pointer, name=nil, filter=-1, connection=nil)
+      http = connection.nil? ? nil : connection.httpConnect2
+      num_jobs = FFI::Cups.cupsGetJobs2(http, pointer, name, 0, filter)
+      size = Cups::Struct::Job.size
+      jobs = []
+      
+      num_jobs.times do |i|
+        job = Cups::Struct::Job.new(pointer.get_pointer(0) + (size * i))
+        jobs.push(job)
+      end
+
+      Cups::Connection.close(http) if http
+      return jobs
+    end
   end
 end
 

data/lib/ffi-cups/printer.rb

@@ -54,13 +54,14 @@ module Cups
       end
 
       job_id = FFI::Cups.cupsPrintFile2(http, @name, filename, title, num_options, p_options)
-      job = Cups::Job.new(job_id, title, self)
 
       if job_id.zero?
         last_error = Cups.cupsLastErrorString()
         self.class.cupsFreeOptions(num_options, p_options) unless options.empty?
         raise last_error
       end
+      #job = Cups::Job.new(job_id, title, @name)
+      job = Cups::Job.get_job(job_id, @name, 0, @connection)
 
       self.class.cupsFreeOptions(num_options, p_options) unless options.empty?
       self.class.cupsFreeDests(num_dests, dests)

data/lib/ffi-cups/version.rb

@@ -1,3 +1,3 @@
 module Cups
-  VERSION = "0.1.9"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-cups
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Hugo Marquez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi