https://github.com/bjoernalbers/hylafax
The Ruby HylaFAX Client
https://github.com/bjoernalbers/hylafax
Last synced: 2 months ago
JSON representation
The Ruby HylaFAX Client
- Host: GitHub
- URL: https://github.com/bjoernalbers/hylafax
- Owner: bjoernalbers
- License: mit
- Created: 2017-10-12T16:16:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T14:20:08.000Z (about 4 years ago)
- Last Synced: 2024-04-24T22:43:00.361Z (about 1 year ago)
- Language: Ruby
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# The Ruby HylaFAX Client
[](https://badge.fury.io/rb/hylafax)
[](https://travis-ci.org/bjoernalbers/hylafax)
Send faxes with a
[HylaFAX](http://www.hylafax.org/)
server via Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'hylafax'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install hylafax
## Usage
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
```
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
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](https://github.com/bjoernalbers/hylafax).
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org)
code of conduct.
## License
The gem is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).
## 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](https://github.com/bjoernalbers/hylafax/blob/master/CODE_OF_CONDUCT.md).