sps_bill 0.1.0

data/spec/unit/bill_collection_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe SpsBill::BillCollection do
+
+  describe "##load" do
+    let(:bills) { SpsBill::BillCollection.load(path_spec) }
+    subject { bills }
+
+    context "when path spec provided" do
+      let(:path_spec) { '*.pdf' }
+      let(:mock_collection) { ['a.pdf','b.pdf'] }
+      before do
+        Dir.stub(:[]).and_return(mock_collection)
+        SpsBill::Bill.any_instance.stub(:do_complete_parse).and_return(nil)
+      end
+      it { should be_a(SpsBill::BillCollection) }
+      its(:size) { should eql(2) }
+
+      describe "#first" do
+        subject { bills.first }
+        it { should be_a(SpsBill::Bill) }
+        its(:source_file) { should eql('a.pdf') }
+      end
+      describe "#last" do
+        subject { bills.last }
+        it { should be_a(SpsBill::Bill) }
+        its(:source_file) { should eql('b.pdf') }
+      end
+    end
+
+    context "when file array provided" do
+      let(:path_spec) { ['a.pdf','b.pdf'] }
+      before do
+        SpsBill::Bill.any_instance.stub(:do_complete_parse).and_return(nil)
+      end
+      it { should be_a(SpsBill::BillCollection) }
+      its(:size) { should eql(2) }
+
+      describe "#first" do
+        subject { bills.first }
+        it { should be_a(SpsBill::Bill) }
+        its(:source_file) { should eql('a.pdf') }
+      end
+      describe "#last" do
+        subject { bills.last }
+        it { should be_a(SpsBill::Bill) }
+        its(:source_file) { should eql('b.pdf') }
+      end
+    end
+  end
+
+  describe "#headers" do
+    {
+      :total_amounts => ['invoice_month','amount'],
+      :electricity_usages => ['invoice_month','kwh','rate','amount'],
+      :gas_usages => ['invoice_month','kwh','rate','amount'],
+      :water_usages => ['invoice_month','cubic_m','rate','amount'],
+      :all_data => ['invoice_month','measure','kwh','cubic_m','rate','amount'],
+      :unknown => nil
+    }.each do |dataset_selector,expected|
+      context "with #{dataset_selector} selector" do
+        subject { SpsBill::BillCollection.new.headers(dataset_selector) }
+        it { should eql(expected) }
+      end
+    end
+  end
+
+  describe "#total_amounts" do
+    let(:bill_a) { SpsBill::Bill.new(nil) }
+    let(:bill_b) { SpsBill::Bill.new(nil) }
+    let(:bills) { SpsBill::BillCollection.new }
+    before do
+      bill_a.instance_variable_set(:@invoice_month, Date.parse('2012-02-01'))
+      bill_a.instance_variable_set(:@total_amount, 111.12)
+      bill_b.instance_variable_set(:@invoice_month, Date.parse('2012-03-01'))
+      bill_b.instance_variable_set(:@total_amount, 222.23)
+      bills << bill_a
+      bills << bill_b
+    end
+    subject { bills.total_amounts(style) }
+    context "with solo style" do
+      let(:style) { :solo }
+      let(:expected) { [['2012-02-01',111.12],['2012-03-01',222.23]] }
+      it { should eql(expected)}
+    end
+    context "with all style" do
+      let(:style) { :all }
+      let(:expected) { [['2012-02-01','total_charges',nil,nil,nil,111.12],['2012-03-01','total_charges',nil,nil,nil,222.23]] }
+      it { should eql(expected)}
+    end
+  end
+
+  describe "#electricity_usages" do
+    let(:bill_a) { SpsBill::Bill.new(nil) }
+    let(:bill_b) { SpsBill::Bill.new(nil) }
+    let(:bills) { SpsBill::BillCollection.new }
+    before do
+      bill_a.instance_variable_set(:@invoice_month, Date.parse('2012-02-01'))
+      bill_a.instance_variable_set(:@electricity_usage, [{ kwh: 12.0, rate: 0.1234, amount: 12.34 }] )
+      bill_b.instance_variable_set(:@invoice_month, Date.parse('2012-03-01'))
+      bill_b.instance_variable_set(:@electricity_usage, [{ kwh: 24.0, rate: 0.5678, amount: 56.78 }])
+      bills << bill_a
+      bills << bill_b
+    end
+    subject { bills.electricity_usages(style) }
+    context "with solo style" do
+      let(:style) { :solo }
+      let(:expected) { [['2012-02-01', 12.0, 0.1234, 12.34],['2012-03-01', 24.0, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+    context "with all style" do
+      let(:style) { :all }
+      let(:expected) { [['2012-02-01', 'electricity', 12.0, nil, 0.1234, 12.34],['2012-03-01', 'electricity', 24.0, nil, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+  end
+
+
+  describe "#gas_usages" do
+    let(:bill_a) { SpsBill::Bill.new(nil) }
+    let(:bill_b) { SpsBill::Bill.new(nil) }
+    let(:bills) { SpsBill::BillCollection.new }
+    before do
+      bill_a.instance_variable_set(:@invoice_month, Date.parse('2012-02-01'))
+      bill_a.instance_variable_set(:@gas_usage, [{ kwh: 12.0, rate: 0.1234, amount: 12.34 }] )
+      bill_b.instance_variable_set(:@invoice_month, Date.parse('2012-03-01'))
+      bill_b.instance_variable_set(:@gas_usage, [{ kwh: 24.0, rate: 0.5678, amount: 56.78 }])
+      bills << bill_a
+      bills << bill_b
+    end
+    subject { bills.gas_usages(style) }
+    context "with solo style" do
+      let(:style) { :solo }
+      let(:expected) { [['2012-02-01', 12.0, 0.1234, 12.34],['2012-03-01', 24.0, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+    context "with all style" do
+      let(:style) { :all }
+      let(:expected) { [['2012-02-01', 'gas', 12.0, nil, 0.1234, 12.34],['2012-03-01', 'gas', 24.0, nil, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+  end
+
+  describe "#water_usages" do
+    let(:bill_a) { SpsBill::Bill.new(nil) }
+    let(:bill_b) { SpsBill::Bill.new(nil) }
+    let(:bills) { SpsBill::BillCollection.new }
+    before do
+      bill_a.instance_variable_set(:@invoice_month, Date.parse('2012-02-01'))
+      bill_a.instance_variable_set(:@water_usage, [{ cubic_m: 12.0, rate: 0.1234, amount: 12.34 }] )
+      bill_b.instance_variable_set(:@invoice_month, Date.parse('2012-03-01'))
+      bill_b.instance_variable_set(:@water_usage, [{ cubic_m: 24.0, rate: 0.5678, amount: 56.78 }])
+      bills << bill_a
+      bills << bill_b
+    end
+    subject { bills.water_usages(style) }
+    context "with solo style" do
+      let(:style) { :solo }
+      let(:expected) { [['2012-02-01', 12.0, 0.1234, 12.34],['2012-03-01', 24.0, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+    context "with all style" do
+      let(:style) { :all }
+      let(:expected) { [['2012-02-01', 'water', nil, 12.0, 0.1234, 12.34],['2012-03-01', 'water', nil, 24.0, 0.5678, 56.78]] }
+      it { should eql(expected)}
+    end
+  end
+
+end

data/spec/unit/bill_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe SpsBill::Bill do
+
+  let(:bill) { SpsBill::Bill.new(nil) }
+  subject { bill }
+
+  describe "##new" do
+    it { should be_a(SpsBill::Bill) }
+  end
+
+  [
+    :source_file,:reader,
+    :account_number,:total_amount,:invoice_date,:invoice_month,
+    :electricity_usage,:gas_usage,:water_usage
+  ].each do |supported_attribute|
+    describe "##{supported_attribute}" do
+      it { should respond_to(supported_attribute) }
+    end
+  end
+
+end

data/spec/unit/pdf/object_hash_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+include PdfSamplesHelper
+
+describe PDF::Reader::ObjectHash do
+
+  context "when there is a junk prefix" do
+    let(:sample_name) { junk_prefix_pdf_sample_name }
+    let(:object_hash) { PDF::Reader::ObjectHash.new(sample_name) }
+    let(:stream) { object_hash.instance_variable_get(:@io) }
+    before { stream.rewind }
+    subject { stream.read(4) }
+    it { should eql("%PDF") }
+  end
+
+end

data/spec/unit/shell_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'getoptions'
+
+describe SpsBill::Shell do
+
+  describe "##usage" do
+    subject { SpsBill::Shell.usage }
+    it "should print help" do
+      STDOUT.should_receive(:puts)
+      subject
+    end
+  end
+
+  describe "with help parameter" do
+    let(:options) { GetOptions.new(SpsBill::Shell::OPTIONS, ['-h']) }
+    let(:shell) { SpsBill::Shell.new(options) }
+    subject { shell.options[:help] }
+    it { should be_true }
+    describe "#run" do
+      subject { shell.run }
+      it "should print usage" do
+        SpsBill::Shell.should_receive(:usage)
+        subject
+      end
+    end
+  end
+
+  describe "with raw parameter" do
+    let(:options) { GetOptions.new(SpsBill::Shell::OPTIONS, ['-r']) }
+    let(:shell) { SpsBill::Shell.new(options) }
+    subject { shell.options[:raw] }
+    it { should be_true }
+    describe "#format_header" do
+      let(:data) { ['some','data'] }
+      subject { shell.format_header(data) }
+      it { should be_nil }
+    end
+  end
+
+  {
+    'all' => :all_data,
+    'charges' => :total_amounts,
+    'electricity' => :electricity_usages,
+    'gas' => :gas_usages,
+    'water' => :water_usages
+  }.each do |data,expected_method|
+    describe "with data=#{data} parameter" do
+      let(:options) { GetOptions.new(SpsBill::Shell::OPTIONS, ['-d',data]) }
+      let(:shell) { SpsBill::Shell.new(options) }
+      subject { shell.options[:data] }
+      it { should eql(data) }
+      describe "#run" do
+        subject { shell.run }
+        it "should export #{expected_method}" do
+          shell.should_receive(:export).with(expected_method)
+          subject
+        end
+      end
+    end
+  end
+
+end

data/sps_bill.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sps_bill"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Gallagher"]
+  s.date = "2012-07-20"
+  s.description = "a library that can read SP Services PDF bills and extract and summarize the bill details"
+  s.email = "gallagher.paul@gmail.com"
+  s.executables = ["sps_bill"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "bin/sps_bill",
+    "lib/pdf/object_hash.rb",
+    "lib/pdf/positional_text_receiver.rb",
+    "lib/pdf/structured_reader.rb",
+    "lib/pdf/textangle.rb",
+    "lib/sps_bill.rb",
+    "lib/sps_bill/bill.rb",
+    "lib/sps_bill/bill_collection.rb",
+    "lib/sps_bill/bill_parser.rb",
+    "lib/sps_bill/shell.rb",
+    "lib/sps_bill/version.rb",
+    "scripts/data/.gitkeep",
+    "scripts/scan_all_bills.sh",
+    "spec/fixtures/pdf_samples/.gitkeep",
+    "spec/fixtures/pdf_samples/junk_prefix.pdf",
+    "spec/fixtures/personal_pdf_samples/.gitkeep",
+    "spec/fixtures/personal_pdf_samples/expectations.yml.sample",
+    "spec/integration/personal_samples_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/bill_examples.rb",
+    "spec/support/pdf_samples_helper.rb",
+    "spec/unit/bill_collection_spec.rb",
+    "spec/unit/bill_spec.rb",
+    "spec/unit/pdf/object_hash_spec.rb",
+    "spec/unit/shell_spec.rb",
+    "sps_bill.gemspec"
+  ]
+  s.homepage = "https://github.com/tardate/sps_bill_scanner"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "SP Services PDF bill structured data reader"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<pdf-reader>, ["= 1.1.1"])
+      s.add_runtime_dependency(%q<getoptions>, ["~> 0.3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.11"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<pdf-reader>, ["= 1.1.1"])
+      s.add_dependency(%q<getoptions>, ["~> 0.3"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.11"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<pdf-reader>, ["= 1.1.1"])
+    s.add_dependency(%q<getoptions>, ["~> 0.3"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.11"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: sps_bill
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Gallagher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: &70313136422520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70313136422520
+- !ruby/object:Gem::Dependency
+  name: getoptions
+  requirement: &70313136421900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70313136421900
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70313136421060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: *70313136421060
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70313136420480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70313136420480
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70313136419920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70313136419920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70313136419140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70313136419140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70313136418160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70313136418160
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70313136417580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: *70313136417580
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70313136417060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70313136417060
+description: a library that can read SP Services PDF bills and extract and summarize
+  the bill details
+email: gallagher.paul@gmail.com
+executables:
+- sps_bill
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/sps_bill
+- lib/pdf/object_hash.rb
+- lib/pdf/positional_text_receiver.rb
+- lib/pdf/structured_reader.rb
+- lib/pdf/textangle.rb
+- lib/sps_bill.rb
+- lib/sps_bill/bill.rb
+- lib/sps_bill/bill_collection.rb
+- lib/sps_bill/bill_parser.rb
+- lib/sps_bill/shell.rb
+- lib/sps_bill/version.rb
+- scripts/data/.gitkeep
+- scripts/scan_all_bills.sh
+- spec/fixtures/pdf_samples/.gitkeep
+- spec/fixtures/pdf_samples/junk_prefix.pdf
+- spec/fixtures/personal_pdf_samples/.gitkeep
+- spec/fixtures/personal_pdf_samples/expectations.yml.sample
+- spec/integration/personal_samples_spec.rb
+- spec/spec_helper.rb
+- spec/support/bill_examples.rb
+- spec/support/pdf_samples_helper.rb
+- spec/unit/bill_collection_spec.rb
+- spec/unit/bill_spec.rb
+- spec/unit/pdf/object_hash_spec.rb
+- spec/unit/shell_spec.rb
+- sps_bill.gemspec
+homepage: https://github.com/tardate/sps_bill_scanner
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: SP Services PDF bill structured data reader
+test_files: []