The Ruby HylaFAX Client

Send faxes with a HylaFAX server via Ruby.

Installation

Add this line to your application's Gemfile:

gem 'hylafax'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hylafax

Usage

Sending a fax:

require 'hylafax'

# Send fax and return the job id.
HylaFAX.sendfax(host: '10.2.2.1', dialstring: '0123456', document: 'foo.pdf')
# => 29

Checking fax statuses:

# Query status by job id for completed faxes.
HylaFAX.faxstat(host: '10.2.2.1')
# => {29=>:done, 28=>:done, 27=>:failed}

Development

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

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.