receipt

Receipt

PDF Receipts generator for any ruby application.

Code Status

Installation

Add this line to your application's Gemfile:

gem 'receipt'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install receipt

Usage

receipt = Receipt::Pdf.new(
  id: 1,
  date: Time.now.to_date,
  amount: 100.0,
  currency: '$',
  payer: 'Chucky Norris',
  receiver: 'Fernando Almeida',
  description: 'transaction #123',
  filepath: '/my/receipts/path/file1234.pdf',
  locale: :en # or 'pt-BR'
)

receipt.before_receipt_box { my_header_content_for(receipt) }
receipt.after_receipt_box { my_footer_content_for(receipt) }

# generates file
File.open(receipt.file)

# send to download
send_data(receipt.data, filename: receipt.filename, type: receipt.mimetype)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to use it.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Maintainer

Fernando Almeida

Contributing

1. Fork it ( https://github.com/fernandoalmeida/receipt/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