tbr 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c14b3a149fa446a5777fc978a22ed6f525755825
+  data.tar.gz: 36c40d1947d3f027b7929a5a7776142f0ed91168
+SHA512:
+  metadata.gz: 7e69392f796d8ac96eba528c32c7a51a2f54e92151d5e1ba073b6ea7dc5ff249fff198bdc007e9b926a1f75d72481fbbb02cdeda686e68752f8a380df9e4e533
+  data.tar.gz: 4e4884991307774dcbadb648c8d66a8aa6d8d7149cea2284969afecae1dd64bfbaa81209d0ba8fa9bc1cd1710e2d274a2615ae55e7e0f4379684a002aadb1e89

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+*.pdf
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# TBR Change Log
+
+## Release 0.0.1
+Unsurprisingly, the firat release!  Contains all the basic functionality ported from the [original GTK project.](https://github.com/Bwian/tbr_gtk)
+
+## Release 0.0.2
+Changed API to encapsulate the processing functionality in its own class (Processor).  Functionality now initialised by a simple instance method rather than the previous class method.
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pyrrho Pty Ltd
+
+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,56 @@
+# TBR
+
+The Telstra Billing Reporter gem (tbr) provides functionality to parse monthly billing files produced in accordance with Telstra On Line Billing Service technical specfication version 6.4 and produces detailed and summary billing reports in PDF format. Minor updates to the Telstra specification are unlikely to cause any problems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tbr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tbr
+
+## Usage
+
+Create an instance of Tbr::Processor.  Most instance variables can be set using arguments to initialize or by calling smae named methods on the instance.
+  
+##### initialize(*args)
+Accepts a hash of optional elments with the following keys:  
+
+_:output_   - the pathname of the output directory.  Defaults to /tmp.
+
+_:services_ - a two dimensional array, each row containing the elements service number, group, description and cost centre.  Defaults to an empty array meaning services will not be grouped.
+
+_:log_      - logfile pathname.  Defaults to /dev/null.  STDOUT, STDERR or a file pathname are valid arguments.
+
+_:replace_  - boolean flag which determines replacement of pre-existing output files.  Defaults to false.
+
+_:logo_     - logo pathname.  Defaults to the logo.jpg in the tbr gem
+
+_:original_ - original filename.  Used for log messages if uploaded file uses an anonymous temporary filename
+
+#####  import__services(filename)
+Accepts the path name of a csv file in which the first four cells in each row equate to those in the array of the _:services_ argument to _initialize()_.  The imported array is stored in the _services_ instance variable.
+
+##### process(filename)
+Raises ArgumentError along argument isn't a String.
+
+Raises IOError if the input file doesn't exist.
+
+Log messages are written to track progress and record use of default settings.
+
+A top-level directory is created in the output path named in the format _YYYYDD_, the underlying date being extracted from the Telstra billing file.  A _details_ subdirectory contains separate files for each service.  A _summaries_ subdirectory contains summaries for each service by service group as specified in the _:services_ array argument to _process()_. The top-level directory also contains an overall _Service Totals_ file containing one line per service.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tbr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/tbr.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require "tbr/version"
+
+module Tbr
+  
+	class << self
+		def log
+      @log || Logger.new(STDOUT)
+    end
+    
+    def log=(logger)
+      @log = logger
+    end
+	end	
+
+end
+
+require "tbr/processor"

data/lib/tbr/call_detail.rb

@@ -0,0 +1,24 @@
+require 'time'
+
+class CallDetail
+
+# OBS record type DC - page 41
+	
+	attr_reader :call_type, :duration, :destination, :area, :start_date, :start_time, :cost
+							
+  def initialize(record,call_type)
+  	fields = record.split(',')
+  	if fields[0] == 'DC' && fields[8] == 'D' then  # Call Detail record
+  		@call_type = call_type.desc(fields[9])
+  		@duration = Time.at(fields[10].to_i).gmtime.strftime('%R:%S')
+  		@destination = fields[12]
+  		@area = fields[16]
+  		@start_date = Time.parse(fields[18]).strftime('%d/%m/%Y')
+  		@start_time = fields[20]
+  		@cost = fields[33].to_f
+  	else
+  		raise ArgumentError, "Invalid record type - " + fields[0], caller
+  	end
+  end
+  
+end

data/lib/tbr/call_type.rb

@@ -0,0 +1,23 @@
+class CallType
+
+  def initialize
+    @types = Hash.new
+  end
+  
+  def load(filename)
+  	file = File.new(filename)
+  	@types = Hash.new
+  	file.each_line do |line|
+  		fields = line.split(',')
+  		@types[fields[1]] = fields[3] if fields[0] == 'TC'	
+  	end
+  end
+  
+  def size
+  	@types.size
+  end
+  
+  def desc(code)
+  	@types[code] ? @types[code] : "Unknown service type - " + code
+  end
+end

data/lib/tbr/create_files.rb

@@ -0,0 +1,176 @@
+require 'fileutils'
+require 'prawn'
+require 'prawn/table'
+
+class CreateFiles
+	ROW_COLOUR_ODD    = "EBD6D6"
+	ROW_COLOUR_EVEN   = "FFFFFF"
+	ROW_COLOUR_HEAD   = "D6ADAD"
+	UCB_GREEN				  = "666633"
+	UCB_RED					  = "993333"
+	
+# Header for each phone service
+	attr_reader :invoice_month, :dir_root
+  attr_accessor :logo
+	
+  def initialize(invoice_date,dir_out,replace)
+    @invoice_month  = Time.parse(invoice_date).strftime('%B %Y')
+  	@dir_root       = "#{dir_out || '/tmp'}/#{invoice_date[0..5]}"	
+  	@dir_summaries  = "#{@dir_root}/summaries"
+  	@dir_details    = "#{@dir_root}/details"    
+    @logo           = Tbr::Processor::LOGO_DEFAULT 
+    
+  	FileUtils.rm_rf(@dir_root) if replace
+    if File.exist?(@dir_root)
+      message = "Output directory #{dir_full_root} already exists."
+      Tbr.log.fatal(message)
+      raise IOError, message 
+    end
+  
+    Dir.mkdir(@dir_root) 	
+  	Dir.mkdir(@dir_summaries)
+  	Dir.mkdir(@dir_details)
+  end
+  
+  def group_summary(group)
+  	create_group_summary(group)
+  end
+  
+  def call_details(service)
+  	create_call_details(service)	
+  end
+  
+  def service_totals(services)
+  	create_service_totals(services)
+  end
+  
+  def dir_full_root
+    File.realdirpath(@dir_root)
+  end
+  
+  private
+  
+  def header(pdf,heading,name)	
+    logo_path = @logo
+    pdf.table([
+			[{:image => logo_path, :scale => 0.1, :rowspan => 2}, 
+			{:content => heading, :rowspan => 2, :text_color => UCB_GREEN, :size => 20, :font_style => :bold },
+			{:content => @invoice_month, :text_color => UCB_RED, :font_style => :bold}],
+			[{:content => name, :text_color => UCB_RED, :font_style => :bold}]
+		], :column_widths => [130,260,130]) do
+			cells.padding = 0
+			cells.borders = []
+			column(2).style(:align => :right)
+			column(1).style(:align => :center)
+		end   
+  end
+  
+  def footer(pdf)
+  	page_no = '<page> of <total>'
+		pdf.number_pages(page_no, {:at => [0,0], :align => :center})	
+  end
+  
+  def create_group_summary(group)
+    fname = "#{@dir_summaries}/#{group.name} - #{@invoice_month}.pdf"
+    Prawn::Document.generate(fname, :page_layout => :portrait, :page_size => "A4") do |pdf|
+      header(pdf,"Telstra Billing Summary","Manager: #{group.name}")
+  		group.each do |service| 
+				format_summary(pdf,service)
+			end
+			footer(pdf)
+  	end
+  end
+  
+  def create_call_details(service)
+  	fname = "#{@dir_details}/#{service.service_number} - #{@invoice_month}.pdf"
+  	
+  	data = [['Start','','Type','Destination','Area','Duration','Cost']]
+		service.call_details.each do |cd|
+			data << [cd.start_date, cd.start_time, cd.call_type, cd.destination, cd.area, cd.duration, sprintf("%.2f",cd.cost)]
+		end
+			
+  	Prawn::Document.generate(fname, :page_layout => :portrait, :page_size => "A4") do |pdf|
+  		header(pdf,"Telstra Billing Details","")
+			format_summary(pdf,service)
+			
+			pdf.font_size 10
+			pdf.move_down 18
+			      
+			pdf.table(data, 
+				:row_colors => [ROW_COLOUR_EVEN, ROW_COLOUR_ODD],
+				:header => :true, 
+				:column_widths => [55,45,155,100,80,45,40]) do
+				cells.padding = 2
+				cells.borders = []
+	
+				row(0).font_style = :bold
+				row(0).background_color = ROW_COLOUR_HEAD
+				column(6).style(:align => :right)
+			end
+
+			footer(pdf)
+		end
+  end
+  
+  def create_service_totals(services)
+  	fname = "#{@dir_root}/Service Totals - #{@invoice_month}.pdf"
+  	
+  	grand_total = 0.0
+  	data = [["Number", "Name", "CC", "Total"]]
+  	services.each do |service|
+  		data << [service.service_number_format, service.name, service.cost_centre, sprintf("%.2f", service.total)]
+  		grand_total += service.total	
+  	end
+  	data << ['','','Grand Total:', sprintf('$%8.2f',grand_total)]
+  	
+  	Prawn::Document.generate(fname, :page_layout => :portrait, :page_size => "A4") do |pdf|
+  		header(pdf,"Telstra Service Totals","")
+  		
+  		pdf.font_size 10
+			pdf.move_down 18
+			
+			pdf.table(data, 
+				:row_colors => [ROW_COLOUR_EVEN, ROW_COLOUR_ODD],
+				:header => :true, 
+				:column_widths => [100,270,100,50]) do
+				cells.padding = 2
+				cells.borders = []
+	
+				last = data.size - 1
+				row([0,last]).font_style = :bold
+				row([0,last]).background_color = ROW_COLOUR_HEAD
+				column(3).style(:align => :right)
+			end
+
+			footer(pdf)
+  	end
+  end
+  
+  def format_summary(pdf,service)
+		total = 0.0
+		data = [["Call Type", "Service", "", "", "Cost"]]
+		service.service_summaries.each do |ss|
+			data << ss.to_a
+			total += ss.cost
+		end
+		data << ['','','','Total:', sprintf('$%7.2f',total)]
+		
+		pdf.font_size 10
+		pdf.move_down 18
+		pdf.text("#{service.service_number_format} - #{service.name}", :style => :bold, :align => :center)
+		pdf.move_down 6
+		
+		pdf.table(data, 
+			:row_colors => [ROW_COLOUR_ODD, ROW_COLOUR_EVEN], 
+			:column_widths => [220,150,50,50,50]) do
+			cells.padding = 2
+			cells.borders = []
+
+			last = data.size - 1
+			row([0,last]).font_style = :bold
+			row([0,last]).background_color = ROW_COLOUR_HEAD
+			column([2,4]).style(:align => :right)
+		end
+  end
+
+end

data/lib/tbr/group.rb

@@ -0,0 +1,22 @@
+class Group
+
+# Phone services grouped for
+	attr_reader :name
+	
+  def initialize(name)
+  	@name = name
+  	@services = Array.new
+  end
+    
+  def add_service(service)
+  	@services << service
+  end
+
+	def size
+  	@services.size
+  end
+  
+	def each(&blk)
+  	@services.each(&blk)
+  end 
+end

data/lib/tbr/groups.rb

@@ -0,0 +1,25 @@
+class Groups
+
+# Groups container
+	
+  def initialize
+  	@groups = Hash.new
+  end
+  
+  def group(name)
+  	return nil if name.nil? or name.empty?
+    
+    unless @groups.include?(name)
+  		@groups[name] = Group.new(name) 
+  	end
+  	@groups[name]
+  end
+  
+  def size
+  	@groups.size
+  end 
+  
+  def each(&blk)
+    Hash[@groups.sort].each_value(&blk)
+  end 
+end

data/lib/tbr/parse_files.rb

@@ -0,0 +1,96 @@
+require 'csv'
+
+class ParseFiles
+	
+	SERVICE_NUMBER			= 0
+	SERVICE_GROUP				= 1
+	SERVICE_NAME				= 2
+	SERVICE_CC					= 3
+	
+	DH_INVOICE_DATE			= 2
+	OBR_SERVICE_NUMBER	= 6
+		
+	def self.parse_services_file(services_file)
+    out = []
+    begin				
+			CSV.foreach(services_file) do |fields|
+        out << fields if valid_fields(fields)
+			end
+      Tbr.log.warn("Empty or invalid services file: #{services_file}. All services will be classified as unassigned") if out.empty?
+		rescue Errno::ENOENT
+      message = "Error accessing services file: #{services_file}"
+			Tbr.log.error(message)
+      raise IOError, message
+		end
+    out
+	end
+  
+  def self.map_services(groups,services,services_list)			
+		services_list.each do |fields|
+			next if !valid_fields(fields)
+			
+			group = groups.group(fields[SERVICE_GROUP])
+			service = services.service(fields[SERVICE_NUMBER])
+			service.name = fields[SERVICE_NAME]
+			service.cost_centre = fields[SERVICE_CC]
+			group.add_service(service)
+		end
+    Tbr.log.warn("Empty services list. All services will be classified as unassigned") if services.size == 0
+	end
+	
+	def self.parse_bill_file(services,call_type,bill_file)
+		invoice_date = ''
+		
+		begin
+			file = File.new(bill_file)
+			
+			file.each_line do |line|
+				fields = line.split(',')
+				service_number = fields[OBR_SERVICE_NUMBER]
+	
+				case fields[0]
+					when "DH"
+						invoice_date = fields[DH_INVOICE_DATE]
+			
+					when "DS"
+						service = services.service(service_number)
+						service_summary = ServiceSummary.new(line,call_type)   
+						service.add_service_summary(service_summary)
+			
+					when "DC"
+						service = services.service(service_number)
+						call_detail = CallDetail.new(line,call_type)   
+						service.add_call_detail(call_detail)
+				end	
+			end
+      
+      if invoice_date.empty?
+  			message = "Invalid billing file: #{bill_file}"
+  			Tbr.log.fatal(message)
+        raise ArgumentError, message
+      end
+      
+		rescue Errno::ENOENT
+			message = "Error accessing billing file: #{bill_file}"
+			Tbr.log.fatal(message)
+      raise IOError, message
+      
+		rescue ArgumentError => e
+      message = "Error parsing billing file: #{bill_file}"
+			Tbr.log.fatal(message) unless e.message.start_with?('Invalid')
+      raise ArgumentError, message
+    end
+		
+		invoice_date
+	end
+	
+	def self.valid_fields(fields)	
+		return false if fields.size < 4    
+    return false if fields[0].nil? or fields[0].empty? or fields[1].nil? or fields[1].empty?
+    return false unless fields[0].match(/[0-9]/)
+    
+    return true
+	end
+	
+	private_class_method :valid_fields
+end