hylafax 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bafeedd8e5c2a0e7ce1b8b15a40435d7fd12e25d
-  data.tar.gz: 531c59bfbf6b91817103b2f697335af172436c01
+  metadata.gz: 48ac10855d7064eaadb8ccbf8f5981c626275bb6
+  data.tar.gz: 5b01e8cde7fe8b3881803372aeb4ba97bb4265c0
 SHA512:
-  metadata.gz: e536b9f0a9da95a221f6553653b5daf8a87a36fa7744202efa38276d5f5c8307b3f1ccaa0db511329465a9bd35ff3bebd81caefe74ed38aca02f32b634f3354d
-  data.tar.gz: fec8805a6b4e2f3fa47e827c281a114b80b4f638f3dfb4b86871e37dfd62b73bc5a6ac64e5adb0e6e7c96295f79a8466da4e7c6b70ee300736474c21796281f8
+  metadata.gz: ea62247c292a0d0667a17d247acd9f885bb17dd59217638b27f47dce1013430c2623e56dc3d85fb239773979844065fb12b3047a520c32115ee8647372f6985f
+  data.tar.gz: e5f2bf5d99fe1738c11c6803f3e7494cb7e7e96c9a166d14b989da0713685d3b6341ffe744fd517eee017ddec492829071f6c2c848bdc09c515ed8ff816776a6

data/README.md

@@ -1,5 +1,8 @@
 # The Ruby HylaFAX Client
 
+[![Gem Version](https://badge.fury.io/rb/hylafax.svg)](https://badge.fury.io/rb/hylafax)
+[![Build Status](https://travis-ci.org/bjoernalbers/hylafax.svg?branch=master)](https://travis-ci.org/bjoernalbers/hylafax)
+
 Send faxes with a
 [HylaFAX](http://www.hylafax.org/)
 server via Ruby.
@@ -29,9 +32,18 @@ Sending a fax:
 ```ruby
 require 'hylafax'
 
+# Send fax and return the job id.
 HylaFAX.sendfax(host: '10.2.2.1', dialstring: '0123456', document: 'foo.pdf')
+# => 29
+
+```
 
-# This will send the fax and return the job id.
+Checking fax statuses:
+
+```ruby
+# Query status by job id for completed faxes.
+HylaFAX.faxstat(host: '10.2.2.1')
+# => {29=>:done, 28=>:done, 27=>:failed}
 ```
 
 

data/lib/hylafax.rb

@@ -2,10 +2,16 @@ require 'net/ftp'
 require 'digest/md5'
 
 require 'hylafax/version'
+require 'hylafax/command'
 require 'hylafax/send_fax'
+require 'hylafax/fax_stat'
 
 module HylaFAX
   def self.sendfax(*opts)
     SendFax.new(*opts).run
   end
+
+  def self.faxstat(*opts)
+    FaxStat.new(*opts).run
+  end
 end

data/lib/hylafax/command.rb

@@ -0,0 +1,28 @@
+module HylaFAX
+  class Command
+    DEFAULT_HOST     = '127.0.0.1'
+    DEFAULT_PORT     = 4559
+    DEFAULT_USER     = 'anonymous'
+    DEFAULT_PASSWORD = 'anonymous'
+
+    attr_reader :ftp, :host, :port, :user, :password
+
+    def initialize(opts = {})
+      @ftp      = opts.fetch(:ftp)      { Net::FTP.new }
+      @host     = opts.fetch(:host)     { DEFAULT_HOST }
+      @port     = opts.fetch(:port)     { DEFAULT_PORT }
+      @user     = opts.fetch(:user)     { DEFAULT_USER }
+      @password = opts.fetch(:password) { DEFAULT_PASSWORD }
+    end
+
+    private
+
+    def connect
+      ftp.connect(host, port)
+    end
+
+    def login
+      ftp.login(user, password)
+    end
+  end
+end

data/lib/hylafax/fax_stat.rb

@@ -0,0 +1,45 @@
+module HylaFAX
+  class FaxStat < Command
+    DEFAULT_QUEUE = 'doneq'
+    JOB_FORMAT    = '%j %a'
+    STATES        = {
+      '?' => :undefined,
+      'T' => :suspended,
+      'P' => :pending,
+      'S' => :sleeping,
+      'B' => :blocked,
+      'W' => :waiting,
+      'R' => :running,
+      'D' => :done,
+      'F' => :failed,
+    }
+
+    attr_reader :queue
+
+    def initialize(opts = {})
+      super
+      @queue = opts.fetch(:queue) { DEFAULT_QUEUE }
+    end
+
+    def run
+      connect
+      login
+      set_jobformat
+      list
+    end
+
+    private
+
+    def set_jobformat
+      ftp.sendcmd(%Q{JOBFMT "#{JOB_FORMAT}"})
+    end
+
+    def list
+      ftp.list(queue).inject({ }) do |jobs, line|
+        job_id, status = line.split(' ')
+        jobs[job_id.to_i] = STATES[status]
+        jobs
+      end
+    end
+  end
+end

data/lib/hylafax/send_fax.rb

@@ -1,21 +1,12 @@
 module HylaFAX
-  class SendFax
-    DEFAULT_HOST     = '127.0.0.1'
-    DEFAULT_PORT     = 4559
-    DEFAULT_USER     = 'anonymous'
-    DEFAULT_PASSWORD = 'anonymous'
-    DEFAULT_TMP_DIR   = 'tmp'
+  class SendFax < Command
+    DEFAULT_TMP_DIR = 'tmp'
 
-    attr_reader :ftp, :host, :port, :user, :password, :dialstring, :document,
-      :tmp_dir, :job_id
+    attr_reader :dialstring, :document, :tmp_dir, :job_id
 
     def initialize(opts = {})
-      @ftp        = opts.fetch(:ftp)      { Net::FTP.new }
-      @host       = opts.fetch(:host)     { DEFAULT_HOST }
-      @port       = opts.fetch(:port)     { DEFAULT_PORT }
-      @user       = opts.fetch(:user)     { DEFAULT_USER }
-      @password   = opts.fetch(:password) { DEFAULT_PASSWORD }
-      @tmp_dir    = opts.fetch(:tmp_dir)  { DEFAULT_TMP_DIR }
+      super
+      @tmp_dir    = opts.fetch(:tmp_dir) { DEFAULT_TMP_DIR }
       @dialstring = opts.fetch(:dialstring)
       @document   = opts.fetch(:document)
       @job_id     = nil
@@ -35,14 +26,6 @@ module HylaFAX
 
     private
 
-    def connect
-      ftp.connect(host, port)
-    end
-
-    def login
-      ftp.login(user, password)
-    end
-
     def upload_document
       ftp.put(document, remote_document) unless document_uploaded?
     end

data/lib/hylafax/version.rb

@@ -1,3 +1,3 @@
 module HylaFAX
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hylafax
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Björn Albers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,8 @@ files:
 - bin/setup
 - hylafax.gemspec
 - lib/hylafax.rb
+- lib/hylafax/command.rb
+- lib/hylafax/fax_stat.rb
 - lib/hylafax/send_fax.rb
 - lib/hylafax/version.rb
 homepage: https://github.com/bjoernalbers/hylafax
@@ -96,5 +98,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: hylafax-0.1.0
+summary: hylafax-0.2.0
 test_files: []