hylafax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bafeedd8e5c2a0e7ce1b8b15a40435d7fd12e25d
+  data.tar.gz: 531c59bfbf6b91817103b2f697335af172436c01
+SHA512:
+  metadata.gz: e536b9f0a9da95a221f6553653b5daf8a87a36fa7744202efa38276d5f5c8307b3f1ccaa0db511329465a9bd35ff3bebd81caefe74ed38aca02f32b634f3354d
+  data.tar.gz: fec8805a6b4e2f3fa47e827c281a114b80b4f638f3dfb4b86871e37dfd62b73bc5a6ac64e5adb0e6e7c96295f79a8466da4e7c6b70ee300736474c21796281f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bjoernalbers@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hylafax.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# The Ruby HylaFAX Client
+
+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'
+
+HylaFAX.sendfax(host: '10.2.2.1', dialstring: '0123456', document: 'foo.pdf')
+
+# This will send the fax and return the job id.
+```
+
+
+## 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.
+
+
+## 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).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hylafax"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hylafax.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hylafax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hylafax'
+  spec.version       = HylaFAX::VERSION
+  spec.authors       = ['Björn Albers']
+  spec.email         = ['bjoernalbers@gmail.com']
+
+  spec.summary       = "#{spec.name}-#{spec.version}"
+  spec.description   = 'The Ruby HylaFAX Client'
+  spec.homepage      = 'https://github.com/bjoernalbers/hylafax'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/hylafax.rb

@@ -0,0 +1,11 @@
+require 'net/ftp'
+require 'digest/md5'
+
+require 'hylafax/version'
+require 'hylafax/send_fax'
+
+module HylaFAX
+  def self.sendfax(*opts)
+    SendFax.new(*opts).run
+  end
+end

data/lib/hylafax/send_fax.rb

@@ -0,0 +1,83 @@
+module HylaFAX
+  class SendFax
+    DEFAULT_HOST     = '127.0.0.1'
+    DEFAULT_PORT     = 4559
+    DEFAULT_USER     = 'anonymous'
+    DEFAULT_PASSWORD = 'anonymous'
+    DEFAULT_TMP_DIR   = 'tmp'
+
+    attr_reader :ftp, :host, :port, :user, :password, :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 }
+      @dialstring = opts.fetch(:dialstring)
+      @document   = opts.fetch(:document)
+      @job_id     = nil
+    end
+
+    def run
+      connect
+      login
+      upload_document
+      create_new_job
+      set_lasttime
+      set_dialstring
+      set_document
+      submit_job
+      job_id
+    end
+
+    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
+
+    def remote_document
+      File.join(tmp_dir, document_filename)
+    end
+
+    def document_filename
+      @document_filename ||= Digest::MD5.file(document).hexdigest
+    end
+
+    def document_uploaded?
+      ftp.list(tmp_dir).map { |l| l.split.last }.include?(document_filename)
+    end
+
+    def create_new_job
+      /jobid:\s+(\d+)\s+/ =~ ftp.sendcmd('JNEW')
+      @job_id = $1.to_i if $1
+    end
+
+    def set_lasttime
+      ftp.sendcmd('JPARM LASTTIME 000259')
+    end
+
+    def set_dialstring
+      ftp.sendcmd("JPARM DIALSTRING \"#{dialstring}\"")
+    end
+
+    def set_document
+      ftp.sendcmd("JPARM DOCUMENT \"#{remote_document}\"")
+    end
+
+    def submit_job
+      ftp.sendcmd('JSUBM')
+    end
+  end
+end

data/lib/hylafax/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hylafax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Björn Albers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-16 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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
+email:
+- bjoernalbers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hylafax.gemspec
+- lib/hylafax.rb
+- lib/hylafax/send_fax.rb
+- lib/hylafax/version.rb
+homepage: https://github.com/bjoernalbers/hylafax
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: hylafax-0.1.0
+test_files: []