simple_invoice-emailer 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    simple_invoice-emailer (0.0.0)
+      mail
+      text-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    polyglot (0.3.3)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    text-table (1.2.3)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  simple_invoice-emailer!

data/lib/simple_invoice/emailer/email_invoice_text_table.rb

@@ -0,0 +1,108 @@
+require 'text-table'
+
+module SimpleInvoice
+  module Emailer
+    class EmailInvoiceTextTable
+
+      def initialize
+        @table = Text::Table.new
+        @table.rows = []
+        @invoice_rows = []
+      end
+
+      def line_item values
+        @invoice_rows << values.values_at(*[:description, :price, :quantity, :total]).collect(&:to_s)
+      end
+
+      def total total
+        @total = total
+      end
+
+      # @return [String]
+      def text_table
+        @table.head = left ['Description', 'Price', 'Quantity', 'Total']
+        set_column_alignments [:left, :right, :right, :right]
+        @invoice_rows.each do |row|
+          add_row row
+        end
+        @table.foot = [{:value => 'Total', :colspan => 3}, right(@total)]
+        @table
+      end
+
+      def to_s
+        text_table.to_s
+      end
+
+      private
+
+      def set_column_alignments alignments
+        @alignments = alignments
+      end
+
+      # @param row [Array<String>]
+      def add_row row
+        rows = rows_multi_line row
+        rows.each do |row|
+          @table.rows << row_with_alignments(row)
+        end
+      end
+
+      # @param row [Array<String>]
+      def rows_multi_line row
+        if (n = number_of_lines row) > 1
+          split_into_lines = row.collect do |value|
+            value.split("\n")
+          end
+          (0...n).collect do |index|
+            split_into_lines.collect do |lines|
+              lines[index]
+            end
+          end
+        else
+          [row]
+        end
+      end
+
+      # @param row [Array<String>]
+      def number_of_lines row
+        row.collect do |value|
+          value.count "\n"
+        end.max + 1
+      end
+
+      # @param row [Array<String>]
+      # @return [Array<Hash>]
+      def row_with_alignments row
+        row.zip(@alignments).collect do |value, alignment|
+          align value, alignment
+        end
+      end
+
+      # @param value [String]
+      # @return [Hash]
+      def left value
+        align value, :left
+      end
+
+      # @param value [String]
+      # @return [Hash]
+      def right value
+        align value, :right
+      end
+
+      # @param value [String, Array<String>]
+      # @param alignment [Symbol]
+      # @return [Hash, Array<Hash>]
+      def align value, alignment
+        if value.is_a? Array
+          value.collect do |val|
+            align val, alignment
+          end
+        else
+          {:value => value, :align => alignment}
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/emailer/mail_config.rb

@@ -0,0 +1,46 @@
+module SimpleInvoice
+  module Emailer
+    class MailConfig
+
+      class << self
+
+        extend Forwardable
+        def_delegator :instance, :[]
+
+        def instance
+          @instance ||= new
+        end
+
+        # @param email [String]
+        def email_from email
+          instance[:email_from] = email
+        end
+
+        # @param subject [#call]
+        def email_subject subject
+          instance[:email_subject] = subject
+        end
+
+        # @param name [String]
+        def organisation_name name
+          instance[:organisation_name] = name
+        end
+
+      end
+
+      def initialize
+        @config_hash = {}
+      end
+
+      def [](key)
+        @config_hash[key]
+      end
+
+      def []=(key, value)
+        @config_hash[key] = value
+      end
+    end
+  end
+end
+
+

data/lib/simple_invoice/emailer/mailer.rb

@@ -0,0 +1,45 @@
+module SimpleInvoice
+  module Emailer
+    class Mailer
+
+      # @param mail_config [SimpleInvoice::Emailer::MailConfig]
+      def initialize mail_config=MailConfig
+        @mail_config = mail_config
+      end
+
+      # @param invoice [SimpleInvoice::Invoice]
+      def deliver! invoice
+        mail_instance(invoice).deliver
+      end
+
+      private
+
+      def mail_instance invoice
+        _email_from = get_config(:email_from)
+        _email_subject = email_subject(invoice)
+        _email_body = email_body(invoice)
+        Mail.new do
+          to invoice.contact.email
+          from _email_from
+          subject _email_subject
+          body _email_body
+        end
+      end
+
+      def email_body invoice
+        TextBody.new(invoice, @mail_config).email_body
+      end
+
+      def email_subject invoice
+        get_config(:email_subject)[invoice]
+      end
+
+      def get_config key
+        @mail_config[key].tap do |value|
+          raise "Missing config key #{key}" if value.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/emailer/text_body.rb

@@ -0,0 +1,67 @@
+module SimpleInvoice
+  module Emailer
+    class TextBody
+
+      # @param invoice [SimpleInvoice::Invoice]
+      def initialize invoice, mail_config=MailConfig
+        @invoice = invoice
+        @mail_config = mail_config
+      end
+
+      # @return [String]
+      def email_body
+        salutation + "\n" +
+        "\n" +
+        preamble + "\n" +
+        "\n" +
+        invoice_data +
+        "\n" +
+        "Invoice Items:\n" +
+        line_items_table +
+        "\n" +
+        postscript + "\n"
+      end
+
+      def salutation
+        "Dear #{@invoice.contact.name}"
+      end
+
+      def preamble
+        "This email is an invoice for services by #{@mail_config[:organisation_name]}."
+      end
+
+      def postscript
+        ""
+      end
+
+      def invoice_data
+        list = TextList.new
+        list.add 'Invoice Number', @invoice.invoice_number
+        list.add 'Amount Due', dollars(@invoice.line_items.total)
+        list.add 'Due Date', @invoice.due_date
+        list.to_s
+      end
+
+      def line_items_table
+        table = EmailInvoiceTextTable.new
+        @invoice.line_items.to_a.each do |line_item|
+          table.line_item :description => line_item.description,
+                          :price => dollars(line_item.price),
+                          :quantity => line_item.quantity,
+                          :total => dollars(line_item.total)
+        end
+        table.total dollars(@invoice.line_items.total)
+        table.to_s
+      end
+
+      # @param total_cents [Fixnum]
+      # @return [String]
+      def dollars total_cents
+        dollar = total_cents / 100
+        cents = total_cents % 100
+        "$%d.%02d" % [dollar, cents]
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/emailer/text_list.rb

@@ -0,0 +1,49 @@
+require 'text-table'
+
+module SimpleInvoice
+  module Emailer
+    class TextList
+
+      def initialize
+        @table = Text::Table.new :horizontal_padding    => 1,
+                                 :vertical_boundary     => ' ',
+                                 :horizontal_boundary   => ' ',
+                                 :boundary_intersection => ' '
+        @table.rows = []
+      end
+
+      def add label, value
+        @table.rows << [{:value => "#{label}:", :align => :right}, value.to_s]
+      end
+
+      def to_s
+        reduce_gap(unindent(remove_empty_lines(@table.to_s))) + "\n"
+      end
+
+      private
+
+      def remove_empty_lines str
+        str.gsub(/\n\s+\n/, "\n").gsub(/^\s+\n/, "")
+      end
+
+      # also removes trailing spaces from each line
+      def unindent str
+        lines = str.split("\n")
+        spaces = minimum_leading_spaces lines
+        lines.collect do |line|
+          line.slice(spaces, line.length).rstrip
+        end.join("\n")
+      end
+
+      def minimum_leading_spaces lines
+        lines.collect do |line|
+          /^\s+/.match(line).to_s.length
+        end.min
+      end
+
+      def reduce_gap str
+        str.gsub(':   ', ':  ')
+      end
+    end
+  end
+end

data/lib/simple_invoice/emailer.rb

@@ -0,0 +1,18 @@
+require 'mail'
+
+module SimpleInvoice
+  module Emailer
+
+    autoload :TextBody, "simple_invoice/emailer/text_body"
+    autoload :EmailInvoiceTextTable, "simple_invoice/emailer/email_invoice_text_table"
+    autoload :TextList, "simple_invoice/emailer/text_list"
+    autoload :Mailer, "simple_invoice/emailer/mailer"
+    autoload :MailConfig, "simple_invoice/emailer/mail_config"
+
+    # @param invoice [SimpleInvoice::Invoice]
+    def self.deliver! invoice
+      Mailer.new.deliver! invoice
+    end
+
+  end
+end

data/simple_invoice-emailer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "simple_invoice-emailer"
+  s.version     = "0.0.1"
+  s.authors     = ["Joel Plane"]
+  s.email       = ["joel.plane@gmail.com"]
+  s.homepage    = "https://github.com/joelplane/simple_invoice-emailer"
+  s.summary     = %q{emailer for SimpleInvoice}
+  s.description = %q{sends SimpleInvoices via email}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "text-table"
+  s.add_dependency "mail"
+  s.add_development_dependency "rspec"
+end

data/spec/email_invoice_text_table_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module SimpleInvoice::Emailer
+  describe EmailInvoiceTextTable do
+
+    example do
+      expected_output =
+        "+-------------+--------+----------+---------+\n" \
+        "| Description | Price  | Quantity | Total   |\n" \
+        "+-------------+--------+----------+---------+\n" \
+        "| Gardening   | $50.00 |        1 |  $50.00 |\n" \
+        "| Lawn Mowing | $60.00 |        1 |  $60.00 |\n" \
+        "+-------------+--------+----------+---------+\n" \
+        "| Total                           | $110.00 |\n" \
+        "+-------------+--------+----------+---------+\n"
+      table = EmailInvoiceTextTable.new
+      table.line_item :description => 'Gardening', :price => "$50.00", :quantity => 1, :total => "$50.00"
+      table.line_item :description => 'Lawn Mowing', :price => "$60.00", :quantity => 1, :total => "$60.00"
+      table.total "$110.00"
+      table.to_s.should == expected_output
+    end
+
+  end
+end

data/spec/mailer_spec.rb

@@ -0,0 +1,50 @@
+module SimpleInvoice::Emailer
+  describe Mailer do
+
+    let :mail_config do
+      email_subject = lambda do |invoice|
+        "Invoice ##{invoice.invoice_number}"
+      end
+      {
+        :email_subject => email_subject,
+        :email_from => 'accounts@example.com'
+      }
+    end
+
+    let :contact do
+      double 'contact', :name => "John Smith", :email => 'john.smith@customer.example.com'
+    end
+
+    let :line_items do
+      double 'line_items', :total => 110_00,
+                           :to_a => [
+                             double('line_item', :description => 'Gardening', :price => 50_00, :quantity => 1, :total => 50_00),
+                             double('line_item', :description => 'Lawn Mowing', :price => 60_00, :quantity => 1, :total => 50_00)
+                           ]
+    end
+
+    let :invoice do
+      double 'invoice', :invoice_number => 123456,
+                        :issue_date => "2013-01-02",
+                        :due_date => "2013-01-09",
+                        :contact => contact,
+                        :line_items => line_items
+    end
+
+
+    subject do
+      Mailer.new(mail_config).tap do |mailer|
+        mailer.stub(:email_body => 'body')
+      end
+    end
+
+    example do
+      mail = subject.send(:mail_instance, invoice)
+      mail.should be_a Mail::Message
+      mail.subject.should == 'Invoice #123456'
+      mail.body.should == 'body'
+      mail.from.should == ['accounts@example.com']
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simple_invoice/emailer'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/text_body_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module SimpleInvoice::Emailer
+  describe TextBody do
+
+    let(:contact) do
+      double 'contact', :name => "John Smith"
+    end
+    let(:line_items) do
+      double 'line_items', :total => 110_00,
+                           :to_a => [
+                             double('line_item', :description => 'Gardening', :price => 50_00, :quantity => 1, :total => 50_00),
+                             double('line_item', :description => 'Lawn Mowing', :price => 60_00, :quantity => 1, :total => 50_00)
+                           ]
+    end
+    let(:invoice) do
+      double 'invoice', :invoice_number => 123456,
+                        :issue_date => "2013-01-02",
+                        :due_date => "2013-01-09",
+                        :contact => contact,
+                        :line_items => line_items
+    end
+    let(:mail_config) do
+      {:organisation_name => "Business"}
+    end
+
+    example do
+      expected_output =
+        "Dear John Smith\n" \
+        "\n" \
+        "This email is an invoice for services by Business.\n" \
+        "\n" \
+        "Invoice Number:  123456\n" \
+        "    Amount Due:  $110.00\n" \
+        "      Due Date:  2013-01-09\n" \
+        "\n" \
+        "Invoice Items:\n" \
+        "+-------------+--------+----------+---------+\n" \
+        "| Description | Price  | Quantity | Total   |\n" \
+        "+-------------+--------+----------+---------+\n" \
+        "| Gardening   | $50.00 |        1 |  $50.00 |\n" \
+        "| Lawn Mowing | $60.00 |        1 |  $50.00 |\n" \
+        "+-------------+--------+----------+---------+\n" \
+        "| Total                           | $110.00 |\n" \
+        "+-------------+--------+----------+---------+"
+      SimpleInvoice::Emailer::TextBody.new(invoice, mail_config).email_body.strip.should == expected_output
+    end
+
+  end
+end

data/spec/text_list_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module SimpleInvoice::Emailer
+  describe TextList do
+
+    example do
+      expected_output =
+        "Invoice Number:  123456\n" \
+        "    Amount Due:  $1,100.00\n" \
+        "      Due Date:  2013-01-01\n"
+      list = TextList.new
+      list.add 'Invoice Number', 123456
+      list.add 'Amount Due', '$1,100.00'
+      list.add 'Due Date', '2013-01-01'
+      list.to_s.should == expected_output
+    end
+
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: simple_invoice-emailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joel Plane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: sends SimpleInvoices via email
+email:
+- joel.plane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- lib/simple_invoice/emailer.rb
+- lib/simple_invoice/emailer/email_invoice_text_table.rb
+- lib/simple_invoice/emailer/mail_config.rb
+- lib/simple_invoice/emailer/mailer.rb
+- lib/simple_invoice/emailer/text_body.rb
+- lib/simple_invoice/emailer/text_list.rb
+- simple_invoice-emailer.gemspec
+- spec/email_invoice_text_table_spec.rb
+- spec/mailer_spec.rb
+- spec/spec_helper.rb
+- spec/text_body_spec.rb
+- spec/text_list_spec.rb
+homepage: https://github.com/joelplane/simple_invoice-emailer
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: emailer for SimpleInvoice
+test_files: []