wicoris-postman 0.10.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rbenv-version
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wicoris-postman.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Björn Albers
+
+MIT License
+
+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,38 @@
+# WiCoRIS-Postman
+
+Deliver letters from WiCoRIS
+
+
+## Installation
+
+    $ gem install wicoris-postman
+
+(NOTE: You might have to prefix this with `sudo`.)
+
+
+## Usage
+
+Just parse JSON files and see if the right command-lines would be
+executed:
+
+    $ postman /Library/FileMaker\ Server/Data/Documents --noop
+
+The real shit (actually fax some letters and trash the JSON-files):
+
+    $ postman /Library/FileMaker\ Server/Data/Documents
+
+
+## Contribution
+
+### Bootstraping
+
+    $ bundle install --path vendor
+
+### Testing
+
+    $ bundle exec cucumber
+
+
+## Copyright
+
+Copyright (c) 2014 Björn Albers

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/postman

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# WiCoRIS-Postman Prototype
+
+require 'wicoris/postman'
+include Wicoris::Postman
+
+CLI.new.run

data/features/copy.feature

@@ -0,0 +1,30 @@
+Feature: Copy letter
+
+  In order to save money, time and trees
+  WiCoRIS-Postman should deliver letters by copying them to shared folder
+
+  Background:
+    Given a letter
+    And a copy job
+    And an output folder
+
+  @announce
+  Scenario: Single copy job
+    When I run postman with output dir
+    Then the letter should have been copied
+    And the job should have been deleted
+    And the copy should have been logged
+
+  @announce
+  Scenario: No copy in NOOP mode
+    When I run postman with output dir in noop mode
+    Then the letter should not have been copied
+    And the job should not have been deleted
+    And the copy should have been logged
+
+  @announce
+  Scenario: Run with config file
+    When I run postman with output dir from config file
+    Then the letter should have been copied
+    And the job should have been deleted
+    And the copy should have been logged

data/features/fax.feature

@@ -0,0 +1,23 @@
+Feature: Fax letter
+
+  In order to save money, time and trees
+  WiCoRIS-Postman should deliver letters by fax
+
+  Background:
+    Given a letter
+    And a fax job
+    And a doubled fax interface
+
+  @announce
+  Scenario: Single fax job
+    When I run postman
+    Then the letter should have been faxed
+    And the job should have been deleted
+    And the fax should have been logged
+
+  @announce
+  Scenario: NOOP mode
+    When I run postman in noop mode
+    Then the letter should not have been faxed
+    And the job should not have been deleted
+    And the fax should have been logged

data/features/step_definitions/copy_steps.rb

@@ -0,0 +1,60 @@
+Given(/^a copy job$/) do
+  @job_dir = 'Documents'
+  @job = File.join(@job_dir, 'copy.json')
+  content = {
+    'type' => 'copy',
+    'file' => @letter,
+    'recipient' => 'Dr. Hasenbein',
+    'patient_first_name' => 'Chuck',
+    'patient_last_name' => 'Norris',
+    'patient_date_of_birth' => '1940-03-10'
+  }
+  create_dir(@job_dir)
+  write_file(@job, content.to_json)
+end
+
+Given(/^an output folder$/) do
+  @output_dir = 'export'
+  create_dir(@output_dir)
+end
+
+
+When(/^I run postman with output dir$/) do
+  cmd = "postman --jobdir Documents --outdir '#{@output_dir}'"
+  run_simple(unescape(cmd))
+end
+
+When(/^I run postman with output dir in noop mode$/) do
+  cmd = "postman --jobdir Documents --outdir '#{@output_dir}' --noop"
+  run_simple(unescape(cmd))
+end
+
+When(/^I run postman with output dir from config file$/) do
+  content = ''
+  content << "jobdir 'Documents'\n"
+  content << "outdir '#{@output_dir}'\n"
+  write_file('config.rb', content)
+  cmd = "postman --config 'config.rb'"
+  run_simple(unescape(cmd))
+end
+
+
+Then(/^the letter should have been copied$/) do
+  @output_file = 'Norris_Chuck_1940-03-10_792e.pdf' # Output file with fingerprint
+  copied_letter = File.join(@output_dir, @output_file)
+  check_file_presence([copied_letter], true)
+end
+
+Then(/^the letter should not have been copied$/) do
+  @output_file = 'Norris_Chuck_1940-03-10_792e.pdf' # Output file with fingerprint
+  copied_letter = File.join(@output_dir, File.basename(@letter))
+  check_file_presence([copied_letter], false)
+end
+
+Then(/^the copy should have been logged$/) do
+  [
+    'Letter delivered',
+    @job,
+    @output_file
+  ].each { |expected| assert_partial_output(expected, all_output) }
+end

data/features/step_definitions/fax_steps.rb

@@ -0,0 +1,45 @@
+Given(/^a fax job$/) do
+  dir = 'Documents'
+  @job = File.join(dir, 'example.json')
+  content = {
+    'type' => 'fax',
+    'file' => @letter,
+    'phone' => '0123456789'
+  }
+  create_dir(dir)
+  write_file(@job, content.to_json)
+end
+
+Given(/^a doubled fax interface$/) do
+  double_cmd('lp')
+end
+
+When(/^I run postman$/) do
+  cmd = 'postman --jobdir Documents'
+  run_simple(unescape(cmd))
+end
+
+When(/^I run postman in noop mode$/) do
+  cmd = 'postman --jobdir Documents --noop'
+  run_simple(unescape(cmd))
+end
+
+def fax_cmd
+  cmd = "lp -d Fax -o phone=00123456789 \"#{@letter}\"".shellsplit
+end
+
+Then(/^the letter should have been faxed$/) do
+  expect(history).to include(fax_cmd), history.to_pretty
+end
+
+Then(/^the letter should not have been faxed$/) do
+  expect(history).to_not include(fax_cmd), history.to_pretty
+end
+
+Then(/^the fax should have been logged$/) do
+  [
+    'Letter delivered',
+    @job,
+    '0123456789'
+  ].each { |expected| assert_partial_output(expected, all_output) }
+end

data/features/step_definitions/postman_steps.rb

@@ -0,0 +1,11 @@
+Given(/^a letter$/) do
+  @letter = write_file('document.pdf', 'chunky bacon').path
+end
+
+Then(/^the job should have been deleted$/) do
+  check_file_presence([@job], false)
+end
+
+Then(/^the job should not have been deleted$/) do
+  check_file_presence([@job], true)
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'aruba-doubles/cucumber'

data/lib/wicoris/postman/cli.rb

@@ -0,0 +1,44 @@
+require 'time'
+module Wicoris
+  module Postman
+    class CLI
+      include Mixlib::CLI
+
+      option :jobdir,
+        :long => '--jobdir DIRECTORY',
+        :short => '-j',
+        :description => 'Directory with all JSON files a.k.a. jobs'
+
+      option :noop,
+        :long => '--noop',
+        :short => '-n',
+        :description => "Don't do anything, just pretend to",
+        :boolean => true,
+        :default => false
+
+      option :outdir,
+        :long => '--outdir DIRECTORY',
+        :short => '-o',
+        :description => 'Output directory for copying letters'
+
+      option :config,
+        :long => '--config CONFIG_FILE',
+        :short => '-c',
+        :description => 'Configuration file for Postman'
+
+      # Run a postman that clears the mailbox.
+      def run
+        Postman.new(opts).run
+      end
+
+      private
+
+      # @returns [Hash] App config
+      def opts
+        parse_options
+        Config.from_file(config[:config]) if config[:config]
+        Config.merge!(config)
+      end
+    end
+  end
+end

data/lib/wicoris/postman/copier.rb

@@ -0,0 +1,79 @@
+require 'fileutils'
+require 'digest/md5'
+
+module Wicoris
+  module Postman
+    class Copier
+      def initialize(job, opts = {})
+        @job = job
+        @opts = opts
+        @logger = opts[:logger]
+      end
+
+      # Copy letter to destination.
+      def run
+        FileUtils.cp(source, destination, :noop => (@opts[:noop] == true))
+        if @logger
+          msg = @job.to_hash
+          msg[:destination] = destination
+          msg[:message] = 'Letter delivered :-)'
+          @logger.info(msg)
+        end
+      end
+
+      private
+
+      # @returns [String] Input filename
+      def source
+        @job.letter
+      end
+
+      # @returns [String] Simple fingerprint of input file.
+      def fingerprint
+        Digest::MD5.hexdigest(File.read(source))[0..3]
+      end
+
+      # @returns [String] Full path to output file
+      def destination
+        File.join(outdir, filename)
+      end
+
+      # @returns [String] Validated output directory
+      def outdir
+        dir = @opts[:outdir]
+        raise 'No output directory given' unless dir
+        raise "Output directory does not exist: #{dir}" unless
+          File.exists? dir
+        raise "Output directory is no directory: '#{dir}'" unless
+          File.directory? dir
+        raise "Output directory not writable: '#{dir}'" unless
+          File.writable? dir
+        @opts[:outdir]
+      end
+
+      # @returns [String] Output filename
+      def filename
+        if filename_components.any? { |c| c.nil? || c.empty? }
+          raise "Missing patient demographics: #{filename_components}"
+        else
+          filename_components.join('_') + suffix
+        end
+      end
+
+      # @returns [Array] Infos to be included in the output filename
+      def filename_components
+        [
+          @job.patient_last_name,
+          @job.patient_first_name,
+          @job.patient_date_of_birth,
+          fingerprint
+        ]
+      end
+
+      # @returns [String] Suffix for output filename
+      def suffix
+        '.pdf'
+      end
+    end
+  end
+end

data/lib/wicoris/postman/fax_machine.rb

@@ -0,0 +1,53 @@
+module Wicoris
+  module Postman
+    class FaxMachine
+      DIALOUT_PREFIX = '0'
+      VALID_PHONE_NUMBER = %r{
+        ^0       # starts with a zero
+        [1-9]{1} # but not with a second zero
+        \d{8,}$  # followed by at least 8 digits
+      }x
+
+      def initialize(job, opts = {})
+        @job = job
+        @opts = opts
+        @logger = opts[:logger]
+      end
+
+      # Actually fax the letter.
+      def run
+        system(command) unless @opts[:noop]
+        if @logger
+          msg = @job.to_hash
+          msg[:message] = 'Letter delivered :-)'
+          @logger.info(msg)
+        end
+      end
+
+      # @returns [String] Validated phone number.
+      def validated_phone
+        raise ArgumentError, 'Missing phone number' unless @job.phone
+        phone = @job.phone.gsub(/(\s|-)+/, '')
+        if phone =~ VALID_PHONE_NUMBER
+          DIALOUT_PREFIX + phone
+        else
+          raise ArgumentError, "Invalid phone number: #{phone}"
+        end
+      end
+
+      private
+
+      # Return the command-line for sending the fax, i.e.:
+      #
+      #   lp -d Fax -o phone=042 "/tmp/foo.pdf"
+      #
+      # @returns [String] command-line
+      def command
+        cmd = %w(lp -d Fax) # TODO: Replace hard-coded fax printer-name 'Fax'!
+        cmd << "-o phone=#{validated_phone}"
+        cmd << "'#{@job.letter}'"
+        cmd.join(' ')
+      end
+    end
+  end
+end

data/lib/wicoris/postman/job.rb

@@ -0,0 +1,77 @@
+module Wicoris
+  module Postman
+    class Job
+      attr_reader :logger
+
+      def initialize(json_file, opts = {})
+        @json_file = json_file
+        @opts = opts
+        @logger = opts[:logger]
+      end
+
+      # @returns [String] Path to actual letter
+      def letter
+        if not File.exists?(file)
+          msg = to_hash
+          msg[:message] = 'Letter does not exist'
+          @opts[:logger].error(msg) if @opts[:logger]
+          raise "Letter does not exist: #{file}" # TODO: DRY!
+        else
+          file
+        end
+      end
+
+      # Process the job
+      def process
+        # NOTE: `Object#type` is an existing method in Ruby 1.8.7, therefore we
+        # have to fetch the attribute from the JSON hash.
+        delivery_method =
+          case json['type']
+          when 'fax'  then FaxMachine
+          when 'copy' then Copier
+          # TODO: Handle unknown case!
+          #else
+          #  ...
+          end
+        delivery_method.new(self, @opts).run
+      end
+
+      # Remove the JSON file.
+      def clear!
+        FileUtils.rm(@json_file, :noop => (@opts[:noop] == true)) if json
+      rescue JSON::ParserError
+        logger.warn :message   => 'Refused to delete non-JSON file.',
+                    :json_file => @json_file
+      end
+
+      # @returns [Hash] Job properties
+      def to_hash
+        properties = { 'json_file' => @json_file }
+        properties.merge(json)
+      rescue
+        properties
+      end
+
+      private
+
+      # Parse and return the JSON.
+      # @returns [Hash] Cached JSON.
+      def json
+        @json ||= JSON.parse(json_file_content)
+      end
+
+      # FileMaker creates JSON files with Mac OS Roman file encoding.
+      # We have to convert it to UTF-8 in order to avoid cryptic symbols.
+      #
+      # @returns [String] UTF-8 encoded file content.
+      def json_file_content
+        Iconv.conv('UTF-8', 'MacRoman', File.read(@json_file))
+      end
+
+      # Provide convenient methods for accessing JSON attributes.
+      def method_missing(id,*args,&block)
+        json.key?(id.to_s) ? json[id.to_s] : super
+      end
+    end
+  end
+end

data/lib/wicoris/postman/logger.rb

@@ -0,0 +1,27 @@
+module Wicoris
+  module Postman
+    class Logger
+      def initialize
+        STDOUT.sync = true
+      end
+
+      def info(msg)
+        event = msg.merge(
+          :level => :info,
+          :timestamp => Time.now.iso8601
+        )
+        puts event.to_json
+      rescue JSON::ParserError
+        puts event.inspect
+      end
+
+      def error(msg)
+        event = msg.merge(
+          :level => :error,
+          :timestamp => Time.now.iso8601
+        )
+        puts event.to_json
+      end
+    end
+  end
+end

data/lib/wicoris/postman/postman.rb

@@ -0,0 +1,41 @@
+module Wicoris
+  module Postman
+    class Postman
+      def initialize(opts = {})
+        @opts = opts
+        @logger = opts[:logger]
+      end
+
+      # Process each job.
+      def run
+        jobs.each do |job|
+          begin
+            job.process
+          rescue => e
+            @logger.error(e) if @logger
+          ensure
+            job.clear!
+          end
+        end
+      end
+
+      private
+
+      # @returns [Array<Job>] All jobs created each JSON file
+      def jobs
+        json_files.map { |f| Job.new(f, @opts) }
+      end
+
+      # @returns [Array<String>] JSON files in jobdir.
+      def json_files
+        # NOTE: This performs case-insensitive globbing.
+        Dir.glob(File.join(jobdir, '*.JSON'), File::FNM_CASEFOLD)
+      end
+
+      # @returns [String] Path to jobdir directory
+      def jobdir
+        @opts[:jobdir]
+      end
+    end
+  end
+end

data/lib/wicoris/postman/version.rb

@@ -0,0 +1,5 @@
+module Wicoris
+  module Postman
+    VERSION = '0.10.0'
+  end
+end

data/lib/wicoris/postman.rb

@@ -0,0 +1,22 @@
+require 'cabin'
+require 'json'
+require 'mixlib/cli'
+require 'mixlib/config'
+require 'jlo'
+require 'wicoris/postman/version'
+require 'wicoris/postman/logger'
+require 'wicoris/postman/job'
+require 'wicoris/postman/fax_machine'
+require 'wicoris/postman/copier'
+require 'wicoris/postman/postman'
+require 'wicoris/postman/cli'
+
+module Wicoris
+  module Postman
+    class Config
+      extend(Mixlib::Config)
+
+      default :logger, (l = ::Logger.new(STDOUT); l.formatter = ::JLo::JSONEvent; l)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'wicoris/postman'

data/spec/wicoris/postman/cli_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe CLI do
+    let(:cli) { CLI.new }
+
+    describe '#run' do
+      it 'runs a new postman with options' do
+        postman = double('postman')
+        opts = double('config')
+        cli.should_receive(:opts).and_return(opts)
+        Postman.should_receive(:new).ordered.with(opts).and_return(postman)
+        postman.should_receive(:run)
+        cli.run
+      end
+    end
+
+    describe '#opts' do
+      it 'returns the application-wide options' do
+        cli.should_receive(:parse_options).ordered
+        expect(cli.send(:opts)).to eq(Config)
+      end
+
+      it 'reads a given config file'
+
+      it 'merges command-line opts with the global config'
+    end
+
+    describe '#logger' do
+      let(:logger) { double('logger') }
+
+      it 'returns a new ruby-cabin logger' do
+        pending 'logging has changed'
+        Cabin::Channel.should_receive(:new).and_return(logger)
+        logger.should_receive(:subscribe).with(STDOUT)
+        expect(cli.send(:logger)).to eq logger
+      end
+    end
+  end
+end