Contents

# Receipt

PDF Receipts generator for any ruby application.

## Code Status

[![Build Status](https://travis-ci.org/fernandoalmeida/receipt.svg)](https://travis-ci.org/fernandoalmeida/receipt)
[![Code Climate](https://codeclimate.com/github/fernandoalmeida/receipt/badges/gpa.svg)](https://codeclimate.com/github/fernandoalmeida/receipt)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'receipt'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install receipt

## Usage

```ruby
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](https://rubygems.org).

## Maintainer

[Fernando Almeida](http://fernandoalmeida.net)

## 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
receipt-0.1.3	README.md