hylafax 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bafeedd8e5c2a0e7ce1b8b15a40435d7fd12e25d
-  data.tar.gz: 531c59bfbf6b91817103b2f697335af172436c01
+SHA256:
+  metadata.gz: fa7d134cb036f06376a5d87efab2b5eee5e737ba4b41c22efff4cc92784430f7
+  data.tar.gz: 43ee998f84f20b5e81ecf07174ef65407c8337500a0ef7428d6b482014f80e39
 SHA512:
-  metadata.gz: e536b9f0a9da95a221f6553653b5daf8a87a36fa7744202efa38276d5f5c8307b3f1ccaa0db511329465a9bd35ff3bebd81caefe74ed38aca02f32b634f3354d
-  data.tar.gz: fec8805a6b4e2f3fa47e827c281a114b80b4f638f3dfb4b86871e37dfd62b73bc5a6ac64e5adb0e6e7c96295f79a8466da4e7c6b70ee300736474c21796281f8
+  metadata.gz: 86cddd5561ed193cf4bb324ed28893e6c4676a50f6a234ba7af4d86bf0fb53b5d09293efc0f296e12dbfc82015e00614dc21f575fdefabb55a0d193b12cf7ecd
+  data.tar.gz: 3b2a60a934dba704dc9b749f7bc9ffdb59b242284deb253b4e236cec94b6a0b27727a2078cbdd2c9dae6d1a396956c5af6f6546e0377a0e5c02499751728bf6f

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.0
+RUN mkdir -p /opt/hylafax
+WORKDIR /opt/hylafax
+COPY . .
+RUN bundle install --binstubs
+CMD ["bash"]

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Björn Albers
+Copyright (c) 2021 Björn Albers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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,19 +32,31 @@ 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}
 ```
 
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake spec` to run the tests.
-You can also run `bin/console` for an interactive prompt that will allow you to
-experiment.
+You need to have Docker installed.
+After checking out the repo, run the tests with:
+
+    $ docker-compose run --rm lib bin/rspec
+
+For an interactive prompt run:
 
+    $ docker-compose run --rm lib bin/console
 
 ## Contributing
 

data/Rakefile

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

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+
+services:
+  lib:
+    build: .
+    tty: true
+    volumes:
+      - .:/opt/hylafax

data/hylafax.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

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,30 @@
+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 }
+
+      @ftp.passive = true if opts[:passive]
+    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,23 +1,22 @@
 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'
+    DEFAULT_PAGEWIDTH = 209
+    DEFAULT_PAGELENGTH = 296
+    DEFAULT_PAGECHOP = 'NONE'
+    DEFAULT_CHOPTHRESHOLD = 0
+    DOCUMENT_PREFIX = 'doc.'
 
-    attr_reader :ftp, :host, :port, :user, :password, :dialstring, :document,
-      :tmp_dir, :job_id
+    attr_reader :dialstring, :document, :tmp_dir, :job_id, :pagewidth,
+      :pagelength
 
     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)
+      @pagewidth  = opts.fetch(:pagewidth) { DEFAULT_PAGEWIDTH }
+      @pagelength  = opts.fetch(:pagelength) { DEFAULT_PAGELENGTH }
       @job_id     = nil
     end
 
@@ -28,6 +27,10 @@ module HylaFAX
       create_new_job
       set_lasttime
       set_dialstring
+      set_pagewidth
+      set_pagelength
+      set_pagechop
+      set_chopthreshold
       set_document
       submit_job
       job_id
@@ -35,14 +38,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
@@ -52,7 +47,8 @@ module HylaFAX
     end
 
     def document_filename
-      @document_filename ||= Digest::MD5.file(document).hexdigest
+      @document_filename ||= DOCUMENT_PREFIX +
+        Digest::MD5.file(document).hexdigest
     end
 
     def document_uploaded?
@@ -72,6 +68,22 @@ module HylaFAX
       ftp.sendcmd("JPARM DIALSTRING \"#{dialstring}\"")
     end
 
+    def set_pagewidth
+      ftp.sendcmd(%Q{JPARM PAGEWIDTH #{pagewidth}})
+    end
+
+    def set_pagelength
+      ftp.sendcmd(%Q{JPARM PAGELENGTH #{pagelength}})
+    end
+
+    def set_pagechop
+      ftp.sendcmd(%Q{JPARM PAGECHOP "#{DEFAULT_PAGECHOP}"})
+    end
+
+    def set_chopthreshold
+      ftp.sendcmd(%Q{JPARM CHOPTHRESHOLD #{DEFAULT_CHOPTHRESHOLD}})
+    end
+
     def set_document
       ftp.sendcmd("JPARM DOCUMENT \"#{remote_document}\"")
     end

data/lib/hylafax/version.rb

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

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: hylafax
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Björn Albers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: The Ruby HylaFAX Client
@@ -59,18 +59,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - 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
@@ -83,18 +87,17 @@ 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.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: hylafax-0.1.0
+summary: hylafax-0.4.0
 test_files: []