wicoris-postman 0.10.0 → 0.11.0

data/features/step_definitions/copy_steps.rb

@@ -54,7 +54,6 @@ end
 Then(/^the copy should have been logged$/) do
   [
     'Letter delivered',
-    @job,
-    @output_file
+    @job
   ].each { |expected| assert_partial_output(expected, all_output) }
 end

data/features/step_definitions/fax_steps.rb

@@ -39,7 +39,6 @@ end
 Then(/^the fax should have been logged$/) do
   [
     'Letter delivered',
-    @job,
-    '0123456789'
+    @job
   ].each { |expected| assert_partial_output(expected, all_output) }
 end

data/lib/wicoris/postman/copier.rb

@@ -13,12 +13,6 @@ module Wicoris
       # 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

data/lib/wicoris/postman/fax_machine.rb

@@ -17,11 +17,6 @@ module Wicoris
       # 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.

data/lib/wicoris/postman/job.rb

@@ -12,10 +12,7 @@ module Wicoris
       # @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!
+          fail "Letter does not exist: #{file}"
         else
           file
         end
@@ -23,17 +20,16 @@ module Wicoris
 
       # 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
+        deliver
+        logger.info :message => 'Letter delivered :-D',
+                    :patient => patient,
+                    :job => @json_file
+      rescue => e
+        logger.error :message => 'Letter not delivered ;-(',
+                     :patient => patient,
+                     :reason => e.message,
+                     :job => @json_file
+        logger.debug e
       end
 
       # Remove the JSON file.
@@ -44,16 +40,35 @@ module Wicoris
                     :json_file => @json_file
       end
 
-      # @returns [Hash] Job properties
-      def to_hash
-        properties = { 'json_file' => @json_file }
-        properties.merge(json)
+      # @returns [String] Patient's display name.
+      def patient
+        format('%s, %s (%s)',
+               patient_last_name,
+               patient_first_name,
+               patient_date_of_birth)
       rescue
-        properties
+        'Unknown'
       end
 
       private
 
+      def deliver
+        delivery_machine.new(self, @opts).run
+      end
+
+      # How we gonna deliver the letter?
+      def delivery_machine
+        # NOTE: `Object#type` is an existing method in Ruby 1.8.7, therefore we
+        # have to fetch the attribute from the JSON hash.
+        case json['type']
+        when 'fax'  then FaxMachine
+        when 'copy' then Copier
+        # TODO: Handle unknown case!
+        #else
+        #  ...
+        end
+      end
+
       # Parse and return the JSON.
       # @returns [Hash] Cached JSON.
       def json

data/lib/wicoris/postman/version.rb

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

data/spec/wicoris/postman/job_spec.rb

@@ -66,6 +66,39 @@ module Wicoris::Postman
     end
 
     describe '#process' do
+      let(:logger) { double('logger') }
+      let(:patient) { 'Norris, Chuck (1940-03-10)' }
+
+      before do
+        job.stub(:logger).and_return(logger)
+        job.stub(:patient).and_return(patient)
+        logger.stub(:info) #todo: remove
+      end
+
+      context 'without errors' do
+        it 'logs a successful delivery' do
+          job.stub(:deliver)
+          logger.should_receive(:info).
+            with :message => 'Letter delivered :-D',
+                 :patient => patient,
+                 :job => 'example.json'
+          job.process
+        end
+      end
+
+      context 'with errors' do
+        it 'logs a failed delivery' do
+          job.stub(:deliver).and_return { fail 'BOOOM!' }
+          logger.should_receive(:error).
+            with :message => 'Letter not delivered ;-(',
+                 :patient => patient,
+                 :reason => 'BOOOM!',
+                 :job => 'example.json'
+          logger.should_receive(:debug)
+          job.process
+        end
+      end
+
       context 'when fax' do
         it 'faxes the letter' do
           job.should_receive(:json).and_return('type' => 'fax')
@@ -87,6 +120,19 @@ module Wicoris::Postman
       end
     end
 
+    describe '#patient' do
+      it 'returns the patient display name' do
+        job.stub(:patient_first_name).and_return('Chuck')
+        job.stub(:patient_last_name).and_return('Norris')
+        job.stub(:patient_date_of_birth).and_return('1940-03-10')
+        expect(job.patient).to eq 'Norris, Chuck (1940-03-10)'
+      end
+
+      it 'returns unknown when patient infos are missing' do
+        expect(job.patient).to eq 'Unknown'
+      end
+    end
+
     describe '#patient_first_name' do
       it 'returns the patients first name' do
         job.stub(:json).and_return('patient_first_name' => 'Chuck')
@@ -150,33 +196,5 @@ module Wicoris::Postman
         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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wicoris-postman
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 51
   prerelease: 
   segments: 
   - 0
-  - 10
+  - 11
   - 0
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - "Bjo\xCC\x88rn Albers"
@@ -19,7 +19,7 @@ date: 2014-03-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -29,12 +29,12 @@ dependencies:
         - 1
         - 8
         version: "1.8"
+  prerelease: false
+  requirement: *id001
   type: :runtime
   name: json_pure
-  version_requirements: *id001
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,12 +44,12 @@ dependencies:
         - 0
         - 6
         version: "0.6"
+  prerelease: false
+  requirement: *id002
   type: :runtime
   name: cabin
-  version_requirements: *id002
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -59,12 +59,12 @@ dependencies:
         - 1
         - 4
         version: "1.4"
+  prerelease: false
+  requirement: *id003
   type: :runtime
   name: mixlib-cli
-  version_requirements: *id003
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -74,12 +74,12 @@ dependencies:
         - 2
         - 1
         version: "2.1"
+  prerelease: false
+  requirement: *id004
   type: :runtime
   name: mixlib-config
-  version_requirements: *id004
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -89,12 +89,12 @@ dependencies:
         - 0
         - 3
         version: "0.3"
+  prerelease: false
+  requirement: *id005
   type: :runtime
   name: jlo
-  version_requirements: *id005
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -104,12 +104,12 @@ dependencies:
         - 1
         - 3
         version: "1.3"
+  prerelease: false
+  requirement: *id006
   type: :development
   name: bundler
-  version_requirements: *id006
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -118,12 +118,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
+  requirement: *id007
   type: :development
   name: rake
-  version_requirements: *id007
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -133,12 +133,12 @@ dependencies:
         - 0
         - 5
         version: "0.5"
+  prerelease: false
+  requirement: *id008
   type: :development
   name: aruba
-  version_requirements: *id008
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -148,10 +148,10 @@ dependencies:
         - 1
         - 2
         version: "1.2"
+  prerelease: false
+  requirement: *id009
   type: :development
   name: aruba-doubles
-  version_requirements: *id009
-  prerelease: false
 description: Deliver letters from WiCoRIS
 email: 
 - bjoernalbers@googlemail.com
@@ -223,7 +223,7 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: wicoris-postman-0.10.0
+summary: wicoris-postman-0.11.0
 test_files: 
 - features/copy.feature
 - features/fax.feature