wicoris-postman 0.10.0

data/spec/wicoris/postman/copier_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe Copier do
+    let(:job) { double('job') }
+    let(:copier) { Copier.new(job, {}) }
+
+    describe '#run' do
+
+      before do
+        job.stub(:letter).and_return('/tmp/foo.pdf')
+        copier.stub(:destination).and_return('/export')
+      end
+
+      context 'without noop' do
+        let(:copier) { Copier.new(job, {}) }
+
+        it 'copies the letter to destination' do
+          copier.should_receive(:source).and_return('/chunky.pdf')
+          copier.should_receive(:destination).and_return('/bacon.pdf')
+          FileUtils.should_receive(:cp).
+            with('/chunky.pdf', '/bacon.pdf', :noop => false)
+          copier.run
+        end
+      end
+
+      context 'with noop' do
+        let(:copier) { Copier.new(job, :noop => true) }
+
+        it 'does not copy the letter to destination' do
+          FileUtils.should_receive(:cp).
+            with('/tmp/foo.pdf', '/export', :noop => true)
+          copier.run
+        end
+      end
+    end
+
+    describe '#source' do
+      it 'returns the letter' do
+        job.should_receive(:letter).and_return('/chunky/bacon.pdf')
+        expect(copier.send(:source)).to eq '/chunky/bacon.pdf'
+      end
+    end
+
+    describe '#fingerprint' do
+      it 'returns the first 4 bytes of the source hexdigest' do
+        copier.should_receive(:source).and_return('/chunky/bacon.pdf')
+        File.should_receive(:read).with('/chunky/bacon.pdf').
+          and_return('content')
+        Digest::MD5.should_receive(:hexdigest).with('content').
+          and_return('cafebabedeadbeef')
+        expect(copier.send(:fingerprint)).to eq 'cafe'
+      end
+    end
+
+    describe '#destination' do
+      it 'returns full path from output filename' do
+        copier.should_receive(:outdir).and_return('/chunky')
+        copier.should_receive(:filename).and_return('bacon.pdf')
+        expect(copier.send(:destination)).to eq '/chunky/bacon.pdf'
+      end
+    end
+
+    describe '#outdir' do
+      let(:copier) { Copier.new(job, {:outdir => '/chunky'}) }
+
+      before do
+        [:exists?, :directory?, :writable?].each do |method|
+          File.stub(method).and_return(true)
+        end
+      end
+
+      it 'returns the output dir' do
+        expect(copier.send(:outdir)).to eq '/chunky'
+      end
+
+      it 'raises when directory does not exist' do
+        File.should_receive(:exists?).and_return(false)
+        expect { copier.send(:outdir) }.to raise_error(
+          %r{output directory does not exist: /chunky}i)
+      end
+
+      it 'raises when not a directory' do
+        File.should_receive(:directory?).and_return(false)
+        expect { copier.send(:outdir) }.to raise_error(
+          %r{output directory is no directory: '/chunky'}i)
+      end
+
+      it 'raises when not writable' do
+        File.should_receive(:writable?).and_return(false)
+        expect { copier.send(:outdir) }.to raise_error(
+          %r{output directory not writable: '/chunky'}i)
+      end
+
+      context 'without outdir' do
+        let(:copier) { Copier.new(job, {:outdir => nil}) }
+
+        it 'raises an error' do
+          expect { copier.send(:outdir) }.to raise_error(
+            %r{No output directory given}i)
+        end
+      end
+    end
+
+    describe '#filename' do
+      it 'returns a filename based on its components and suffix' do
+        copier.stub(:filename_components).
+          and_return %w(chunky bacon 42)
+        copier.stub(:suffix).and_return('.foo')
+        expect(copier.send(:filename)).to eq 'chunky_bacon_42.foo'
+      end
+
+      it 'raises on missing filename component' do
+        copier.stub(:filename_components).
+          and_return ['chunky', nil, 'bacon']
+        expect{ copier.send(:filename) }.to raise_error(
+          /missing patient demographics/i)
+      end
+
+      it 'raises on empty filename component' do
+        copier.stub(:filename_components).
+          and_return ['chunky', '', 'bacon']
+        expect{ copier.send(:filename) }.to raise_error(
+          /missing patient demographics/i)
+      end
+    end
+
+    describe '#filename_components' do
+      it 'orders the components by most relevant patient demographics' do
+        job.should_receive(:patient_first_name).and_return('Chuck')
+        job.should_receive(:patient_last_name).and_return('Norris')
+        job.should_receive(:patient_date_of_birth).and_return('1940-03-10')
+        copier.should_receive(:fingerprint).and_return('abcd')
+        expect(copier.send(:filename_components)).to eq(
+          %w(Norris Chuck 1940-03-10 abcd))
+      end
+    end
+
+    describe '#suffix' do
+      it 'returns the filename suffix' do
+        expect(copier.send(:suffix)).to eq '.pdf'
+      end
+    end
+  end
+end

data/spec/wicoris/postman/fax_machine_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe FaxMachine do
+    let(:job) { double('job') }
+    let(:fax) { FaxMachine.new(job) }
+
+    before do
+      fax.stub(:system)
+    end
+
+    describe '#run' do
+      let(:logger) { double('logger') }
+
+      it 'faxes the document' do
+        fax.stub(:command).and_return('chunky bacon')
+        fax.should_receive(:system).with('chunky bacon')
+        fax.run
+      end
+
+      context 'with noop' do
+        let(:fax) { FaxMachine.new(job, :noop => true) }
+
+        it 'does not fax the job' do
+          fax.stub(:command).and_return('chunky bacon')
+          fax.should_not_receive(:system)
+          fax.run
+        end
+      end
+    end
+
+    describe '#command' do
+      it 'should return the command-line for sending a fax' do
+        fax.stub(:validated_phone).and_return('042')
+        job.stub(:letter).and_return('/tmp/foo.pdf')
+        expect(fax.send(:command)).to eq(
+          "lp -d Fax -o phone=042 '/tmp/foo.pdf'")
+      end
+    end
+
+    describe '#phone' do
+      it 'adds the dial-out prefix' do
+        job.stub(:phone).and_return('0123456789')
+        expect(fax.validated_phone).to eq '00123456789'
+      end
+
+      it 'removes all whitespaces and dashes from the number' do
+        job.stub(:phone).and_return("\t012-345 6789 \n")
+        expect(fax.validated_phone).to eq '00123456789'
+      end
+
+      it 'raises when phone is missing' do
+        job.stub(:phone).and_return(nil)
+        expect{ fax.validated_phone }.to raise_error ArgumentError
+      end
+
+      it 'raises when one leading zero is missing' do
+        job.stub(:phone).and_return('1234567890')
+        expect{ fax.validated_phone }.to raise_error ArgumentError
+      end
+
+      it 'raises when begins with more then one zero' do
+        job.stub(:phone).and_return('00123456789')
+        expect{ fax.validated_phone }.to raise_error ArgumentError
+      end
+
+      it 'raises when shorter then 9 digits' do
+        job.stub(:phone).and_return('01234567')
+        expect{ fax.validated_phone }.to raise_error ArgumentError
+      end
+
+      it 'raises when number contains invalid chars' do
+        job.stub(:phone).and_return('01234hello')
+        expect{ fax.validated_phone }.to raise_error ArgumentError
+      end
+
+      it 'includes the phone number in the exception' do
+        job.stub(:phone).and_return('42')
+        expect{ fax.validated_phone }.to raise_error /42/
+      end
+    end
+  end
+end

data/spec/wicoris/postman/job_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe Job do
+    let(:job) { Job.new('example.json') }
+
+    before do
+      FileUtils.stub(:rm)
+    end
+
+    describe '#json' do
+      it 'parses and returns the JSON file' do
+        job.should_receive(:json_file_content).and_return('content')
+        JSON.should_receive(:parse).with('content').once.and_return('json')
+        2.times { expect(job.send(:json)).to eq 'json' }
+      end
+    end
+
+    describe '#json_file_content' do
+      it 'returns the file content' do
+        File.should_receive(:read).with('example.json').and_return('content')
+        expect(job.send(:json_file_content)).to eq 'content'
+      end
+
+      it 'converts Mac Roman encoding to UTF-8' do
+        File.stub(:read).and_return("Schl\237ter")
+        expect(job.send(:json_file_content)).to eq 'Schlüter'
+      end
+    end
+
+    describe '#letter' do
+      before do
+        File.stub(:exists?).and_return(true)
+      end
+
+      it 'returns the letter path' do
+        job.stub(:json).and_return('file' => '/tmp/foo.pdf')
+        expect(job.letter).to eq '/tmp/foo.pdf'
+      end
+
+      it 'raises when letter is missing' do
+        File.should_receive(:exists?).and_return(false)
+        job.stub(:file).and_return('chunky')
+        expect {
+          job.send(:letter)
+        }.to raise_error /letter does not exist.*chunky/i
+      end
+    end
+
+    describe '#method_missing' do
+      context 'with existing JSON attribute' do
+        it 'returns it' do
+          job.stub(:json).and_return('chunky' => 'bacon')
+          expect(job.chunky).to eq 'bacon'
+        end
+      end
+
+      context 'without matching JSON attribute' do
+        it 'returns it' do
+          job.stub(:json).and_return({})
+          expect {
+            job.chunky
+          }.to raise_error /undefined method/i
+        end
+      end
+    end
+
+    describe '#process' do
+      context 'when fax' do
+        it 'faxes the letter' do
+          job.should_receive(:json).and_return('type' => 'fax')
+          fax_machine = double('fax_machine')
+          FaxMachine.should_receive(:new).with(job, {}).and_return(fax_machine)
+          fax_machine.should_receive(:run).ordered
+          job.process
+        end
+      end
+
+      context 'when copy' do
+        it 'copies the letter' do
+          job.should_receive(:json).and_return('type' => 'copy')
+          copier = double('copier')
+          Copier.should_receive(:new).with(job, {}).and_return(copier)
+          copier.should_receive(:run).ordered
+          job.process
+        end
+      end
+    end
+
+    describe '#patient_first_name' do
+      it 'returns the patients first name' do
+        job.stub(:json).and_return('patient_first_name' => 'Chuck')
+        expect(job.patient_first_name).to eq 'Chuck'
+      end
+    end
+
+    describe '#patient_last_name' do
+      it 'returns the patients last name' do
+        job.stub(:json).and_return('patient_last_name' => 'Norris')
+        expect(job.patient_last_name).to eq 'Norris'
+      end
+    end
+
+    describe '#patient_date_of_birth' do
+      it 'returns the patients date of birth' do
+        job.stub(:json).and_return('patient_date_of_birth' => '1940-03-10')
+        expect(job.patient_date_of_birth).to eq '1940-03-10'
+      end
+    end
+
+    describe '#clear!' do
+      before do
+        job.stub(:json).and_return('')
+      end
+
+      it 'deletes the json file' do
+        FileUtils.should_receive(:rm).with('example.json', :noop => false)
+        job.clear!
+      end
+
+      context 'with noop' do
+        let(:job) { Job.new('example.json', :noop => true) }
+
+        it 'does not delete the json file' do
+          FileUtils.should_receive(:rm).with('example.json', :noop => true)
+          job.clear!
+        end
+      end
+
+      context 'without parsable JSON' do
+        let(:logger) { double('logger', :warn => true) }
+
+        before do
+          job.stub(:json).
+            and_return { raise JSON::ParserError, 'Shitty JSON' }
+          job.stub(:logger).and_return(logger)
+        end
+
+        it 'does not delete the JSON file' do
+          FileUtils.should_not_receive(:rm)
+          job.clear!
+        end
+
+        it 'logs a warning' do
+          logger.should_receive(:warn).with({
+            :message   => 'Refused to delete non-JSON file.',
+            :json_file => 'example.json'
+          })
+          job.clear!
+        end
+      end
+    end
+
+    describe '#to_hash' do
+      let(:job) { Job.new('example.json') }
+
+      context 'with parsable JSON' do
+        before do
+          job.stub(:json).and_return({'chunky' => 'bacon'})
+        end
+
+        it 'includes all JSON attributes' do
+          expect(job.to_hash['chunky']).to eq 'bacon'
+        end
+
+        it 'includes the JSON filename' do
+          expect(job.to_hash['json_file']).to eq 'example.json'
+        end
+      end
+
+      context 'with unparsable JSON' do
+        before do
+          job.stub(:json).and_return { raise JSON::ParserError, 'Shitty JSON' }
+        end
+
+        it 'includes only the JSON filename' do
+          expect(job.to_hash).to eq({'json_file' => 'example.json'})
+        end
+      end
+    end
+  end
+end

data/spec/wicoris/postman/logger_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe Logger do
+    let(:logger) { Logger.new }
+
+    describe '#info' do
+      it 'only accepts one argument' do
+        expect {
+          logger.info('hey', :explosion => true)
+        }.to raise_error
+        #}.to raise_error ArgumentError
+      end
+    end
+
+    describe '#error' do
+    end
+  end
+end

data/spec/wicoris/postman/postman_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module Wicoris::Postman
+  describe Postman do
+    let(:postman) { Postman.new }
+
+    describe '#run' do
+      let(:job) { double('job') }
+
+      it 'processes each job' do
+        postman.should_receive(:jobs).
+          and_return [job, job]
+        job.should_receive(:process).twice
+        job.should_receive(:clear!).twice
+        postman.run
+      end
+
+      it 'clears failed jobs too' do
+        postman.stub(:jobs).and_return [job]
+        job.stub(:process)
+        job.should_receive(:clear!)
+        postman.run
+      end
+
+      context 'when job raises an error' do
+        it 'rescues failed jobs' do
+          postman.stub(:jobs).and_return [job, job]
+          job.should_receive(:process).twice.and_return { raise 'BOOOM!' }
+          job.stub(:clear!)
+          postman.run
+        end
+
+        it 'clears failed jobs too' do
+          postman.stub(:jobs).and_return [job]
+          job.stub(:process).and_return { raise 'BOOOM!' }
+          job.should_receive(:clear!)
+          postman.run
+        end
+      end
+    end
+
+    describe '#jobs' do
+      let(:postman) { Postman.new(:chunky => 'bacon') }
+
+      it 'initializes jobs by json files' do
+        job = double('job')
+        postman.should_receive(:json_files).
+          and_return ['example.json', 'example.json']
+        Job.should_receive(:new).
+          with('example.json', {:chunky => 'bacon'}).twice.and_return(job)
+        expect(postman.send(:jobs)).to eq [job, job]
+      end
+    end
+
+    describe '#json_files' do
+      it 'returns a list of all json files within the jobdir' do
+        postman.should_receive(:jobdir).and_return('jobdir')
+        Dir.should_receive(:glob).with('jobdir/*.JSON', File::FNM_CASEFOLD).
+          and_return('some files')
+        expect(postman.send(:json_files)).to eq 'some files'
+      end
+    end
+
+    describe '#jobdir' do
+      let(:postman) { Postman.new(:jobdir => '/chunky') }
+
+      it 'returns the jobdir from config' do
+        expect(postman.send(:jobdir)).to eq '/chunky'
+      end
+    end
+  end
+end

data/wicoris-postman.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wicoris/postman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wicoris-postman"
+  spec.version       = Wicoris::Postman::VERSION
+  spec.authors       = ["Björn Albers"]
+  spec.email         = ["bjoernalbers@googlemail.com"]
+  spec.description   = %q{Deliver letters from WiCoRIS}
+  spec.summary       = "#{spec.name}-#{spec.version}"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json_pure", "~> 1.8"
+  spec.add_dependency "cabin", "~> 0.6"
+  spec.add_dependency "mixlib-cli", "~> 1.4"
+  spec.add_dependency "mixlib-config", "~> 2.1"
+  spec.add_dependency "jlo", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "aruba", "~> 0.5"
+  spec.add_development_dependency "aruba-doubles", "~> 1.2"
+end