receipts 1.1.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fead98b1a43ff6d6c86b13f9c8114ebcfa322b809f9f2b068b80e03370c63f65
-  data.tar.gz: e7e29ceceac61563c182626d3d47ab697584e67896aff884097bb955236d44ca
+  metadata.gz: a0b0deba0350c50dd06db780729513d9c65d020c9d625b3c61c174078738ef44
+  data.tar.gz: 6b508e3232031df8d6952b9c2da80d5910022b2b53ba29e54f84080c12d522da
 SHA512:
-  metadata.gz: de764a9d7466e6680243ac5b2f033534a6140048f99eb5bc15aaad5b38d27063e4ed7e70f2d45167064dec7b3f941d34b0cab29aab1977e876c926ded6e80839
-  data.tar.gz: 7da1873655534b34d80bb735b8fe80da1d84d6f0618f1d1c7be35991e2d5ffeb197aa4b07390a3ba3aba4317ef42c7a874756b075213422d164ed296b9bb7a2b
+  metadata.gz: f734ad542b0405e91370fd960ab93283bd493cdd0523900b6f97a26f91bc8a57834512c7778c551af55e1208c232020743d39b73428bafe118679439838479f0
+  data.tar.gz: baca857094d744fa1ff47617940a9a665df5fc7da11ebc25e4ac180b9a324b1f00f82f85cfbba09952708e596cbdbe425d73abfab4371f319e7882e3d8dac59e

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ### Unreleased
 
-### 1.2.0
+### 2.1.0
+
+* Add `Receipts.default_font` - @excid3
+
+### 2.0.0
+
+* New, consistent layouts between Receipts, Invoices, and Statements - @excid3
+* PDFs can now be completely customized - @excid3
+* Add line_items to Receipts - @excid3
+
+### 1.1.2
 
 * Update design to give more room for longer product names, addresses, etc - @excid3
 

data/Gemfile

@@ -2,3 +2,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in receipts.gemspec
 gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "standard"
+gem "matrix", "~> 0.4"

data/README.md

@@ -1,10 +1,10 @@
 ![travisci](https://api.travis-ci.org/excid3/receipts.svg)
 
-# Receipts
+# Receipts Gem
 
-Receipts for your Rails application that works with any payment provider.
+Receipts, Invoices, and Statements for your Rails application that works with any payment provider. Receipts uses Prawn to generate the PDFs.
 
-Check out the [example receipt](https://github.com/excid3/receipts/blob/master/examples/receipt.pdf?raw=true) and [example invoice](https://github.com/excid3/receipts/blob/master/examples/invoice.pdf?raw=true) PDFs.
+Check out the [example PDFs](https://github.com/excid3/receipts/blob/master/examples/).
 
 ## Installation
 
@@ -24,112 +24,111 @@ Or install it yourself as:
 
 ## Usage
 
-Adding receipts to your application is pretty simple. All you need is a
-model that stores your transaction details. In this example our
-application has a model named `Charge` that we will use.
+To generate a Receipt, Invoice, or Statement, create an instance and provide content to render:
 
-We're going to add a method called `receipt` on our model called `Charge`
-that will create a new receipt for the charge using attributes from the
-model.
+```ruby
+r = Receipts::Receipt.new(
+  details: [
+    ["Receipt Number", "123"],
+    ["Date paid", Date.today],
+    ["Payment method", "ACH super long super long super long super long super long"]
+  ],
+  company: {
+    name: "Example, LLC",
+    address: "123 Fake Street\nNew York City, NY 10012",
+    email: "support@example.com",
+    logo: File.expand_path("./examples/images/logo.png")
+  },
+  recipient: [
+    "Customer",
+    "Their Address",
+    "City, State Zipcode",
+    nil,
+    "customer@example.org"
+  ],
+  line_items: [
+    ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+    ["Subscription", "$19.00", "1", "$19.00"],
+    [nil, nil, "Subtotal", "$19.00"],
+    [nil, nil, "Tax", "$1.12"],
+    [nil, nil, "Total", "$20.12"],
+    [nil, nil, "<b>Amount paid</b>", "$20.12"],
+    [nil, nil, "Refunded on #{Date.today}", "$5.00"]
+  ],
+  footer: "Thanks for your business. Please contact us if you have any questions."
+)
+
+# Returns a string of the raw PDF
+r.render
+
+# Writes the PDF to disk
+r.render_file "examples/receipt.pdf"
+```
+
+### Configuration
 
-Video Tutorial:
-[GoRails Episode #51](https://gorails.com/episodes/pdf-receipts)
+You can specify the default font for all PDFs by defining the following in an initializer:
 
 ```ruby
-# == Schema Information
-#
-# Table name: charges
-#
-#  id             :integer          not null, primary key
-#  user_id        :integer
-#  stripe_id      :string(255)
-#  amount         :integer
-#  card_last4     :string(255)
-#  card_type      :string(255)
-#  card_exp_month :integer
-#  card_exp_year  :integer
-#  uuid           :string
-#  created_at     :datetime
-#  updated_at     :datetime
-#
-
-class Charge < ActiveRecord::Base
-  belongs_to :user
-  validates :stripe_id, uniqueness: true
-
-  def receipt
-    Receipts::Receipt.new(
-      id: id,
-      subheading: "RECEIPT FOR CHARGE #%{id}",
-      product: "GoRails",
-      company: {
-        name: "GoRails, LLC.",
-        address: "123 Fake Street\nNew York City, NY 10012",
-        email: "support@example.com",
-        logo: Rails.root.join("app/assets/images/logo.png")
-      },
-      line_items: [
-        ["Date",           created_at.to_s],
-        ["Account Billed", "#{user.name} (#{user.email})"],
-        ["Product",        "GoRails"],
-        ["Amount",         "$#{amount / 100}.00"],
-        ["Charged to",     "#{card_type} (**** **** **** #{card_last4})"],
-        ["Transaction ID", uuid]
-      ],
-      font: {
-        bold: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic-Bold.ttf'),
-        normal: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic.ttf'),
-      }
-    )
-  end
-end
+Receipts.default_font = {
+  bold: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic-Bold.ttf'),
+  normal: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic.ttf'),
+}
 ```
 
-Update the options for the receipt according to the data you want to
-display.
 
-## Customizing Your Receipts
+### Options
 
-* `id` - **Required**
+You can pass the following options to generate a PDF:
 
-This sets the ID of the charge on the receipt
+* `recipient` - Array of customer details to include. Typically, this is name, address, email, VAT ID, etc.
 
-* `product` or `message` - **Required**
+* `company` - Hash of your company details
 
-You can set either the product or message options. If you set product, it will use the default message. If you want a custom message, you can set the message option to populate it with custom text.
+  * `name` - Company name
 
-* `company` - **Required**
+  * `address` - Company address
 
-Company consists of several required nested attributes.
+  * `email` - Company support email address
 
-  * `name` - **Required**
-  * `address` - **Required**
-  * `email` - **Required**
-  * `line_items` - **Required**
+  * `phone` - Company phone number - _Optional_
 
-You can set as many line items on the receipts as you want. Just pass in an array with each item containing a name and a value to display on the receipt.
+  * `logo` - Logo to be displayed on the receipt - _Optional_
+    This can be either a Path, File, StringIO, or URL. Here are a few examples:
 
-  * `logo` - *Optional*
+    ```ruby
+    logo: Rails.root.join("app/assets/images/logo.png")
+    logo: File.expand_path("./logo.png")
+    logo: File.open("app/assets/images/logo.png", "rb")
+    logo: "https://www.ruby-lang.org/images/header-ruby-logo@2x.png" # Downloaded with OpenURI
+    ```
 
-The logo must be either a string path to a file or a file-like object.
+* `details` - Array of details about the Receipt, Invoice, Statement. Typically, this is receipt numbers, issue date, due date, status, etc.
 
-```ruby
-logo: Rails.root.join("app/assets/images/logo.png")
-# or
-logo: File.open("app/assets/images/logo.png", "rb")
-```
+* `line_items` - Array of line items to be displayed in table format.
+
+* `footer` - String for a message at the bottom of the PDF.
+
+* `font` - Hash of paths to font files - _Optional_
 
-To use an image from a URL, we recommend using `open-uri` to open the remote file as a StringIO object.
+  ```ruby
+  font: {
+    bold: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic-Bold.ttf'),
+    normal: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic.ttf'),
+  }
+  ```
 
-`require 'open-uri'`
+Here's an example of where each option is displayed.
 
-`logo: URI.open("https://www.ruby-lang.org/images/header-ruby-logo@2x.png")`
+![options](examples/images/options.jpg)
 
-* `font` - *Optional*
+### Formatting
 
-If you'd like to use your own custom font, you can pass in the file paths to the `normal` and `bold` variations of your font. The bold font variation is required because it is used in the default message. If you wish to override that, you can pass in your own custom message instead.
+`details` and `line_items` allow inline formatting with Prawn. This allows you to use HTML tags to format text: `<b>` `<i>` `<u>` `<strikethrough>` `<sub>` `<sup>` `<font>` `<color>` `<link>`
 
-#### Internationalization (I18n)
+See [the Prawn docs](https://prawnpdf.org/api-docs/2.3.0/Prawn/Text.html#text-instance_method) for more information.
+
+### Internationalization (I18n)
 
 You can use `I18n.t` when rendering your receipts to internationalize them.
 
@@ -141,21 +140,53 @@ line_items: [
 ]
 ```
 
-## Rendering the Receipt PDF in your Controller
+### Custom PDF Content
 
-Here we have a charges controller that responds to the show action. When
-you visit it with the PDF format, it calls the `receipt` method that we
-just created on the `Charge` model.
+You can change the entire PDF content by instantiating an Receipts object without any options.
 
-We set the filename to be the date plus the product name. You can
-customize the filename to your liking.
+```ruby
+receipt = Receipts::Receipt.new # creates an empty PDF
+```
 
-Next we set the response type which will be `application/pdf`
+Each Receipts object inherits from Prawn::Document. This allows you to choose what is rendered and include any custom Prawn content you like.
 
-Optionally we can set the `disposition` to `:inline` which allows us to
-render the PDF in the browser without forcing the download. If you
-delete this option or change it to `:attachment` then the receipt will
-be downloaded instead.
+```ruby
+receipt.text("hello world")
+```
+
+You can also use the Receipts helpers in your custom PDFs at the current cursor position.
+
+```ruby
+receipt.text("Custom header")
+receipt.render_line_items([
+  ["my line items"]
+])
+receipt.render_footer("This is a custom footer using the Receipts helper")
+```
+
+### Rendering PDFs
+
+To render a PDF in memory, use `render`. This is recommended for serving PDFs in your Rails controllers.
+
+```ruby
+receipt.render
+```
+
+To render a PDF to disk, use `render_file`:
+
+```ruby
+receipt.render_file "receipt.pdf"
+```
+
+## Rendering PDFs in Rails controller actions
+
+Here's an example Rails controller action you can use for serving PDFs. We'll first look up the database record for the `Charge` we want to render a receipt for.
+
+The `Charge` model has a `receipt` method that returns a `Receipts::Receipt` instance with all the receipt data filled out.
+
+Then we can `render` to generate the PDF in memory. This produces a String with the raw PDF data in it.
+
+Using `send_data` from Rails, we can send the PDF contents and provide the browser with a recommended filename, content type and disposition.
 
 ```ruby
 class ChargesController < ApplicationController
@@ -164,12 +195,7 @@ class ChargesController < ApplicationController
 
   def show
     respond_to do |format|
-      format.pdf {
-        send_data @charge.receipt.render,
-          filename: "#{@charge.created_at.strftime("%Y-%m-%d")}-gorails-receipt.pdf",
-          type: "application/pdf",
-          disposition: :inline
-      }
+      format.pdf { send_pdf }
     end
   end
 
@@ -178,13 +204,18 @@ class ChargesController < ApplicationController
     def set_charge
       @charge = current_user.charges.find(params[:id])
     end
+
+  	def send_pdf
+      # Render the PDF in memory and send as the response
+      send_data @charge.receipt.render,
+        filename: "#{@charge.created_at.strftime("%Y-%m-%d")}-gorails-receipt.pdf",
+        type: "application/pdf",
+        disposition: :inline # or :attachment to download
+    end
 end
 ```
 
-And that's it! Just create a `link_to` to your charge with the format of
-`pdf` and you're good to go.
-
-For example:
+Then, just `link_to` to your charge with the format of `pdf`. For example:
 
 ```ruby
 # config/routes.rb
@@ -192,93 +223,78 @@ resources :charges
 ```
 
 ```erb
-<%= link_to "Download Receipt", charge_path(@charge, format: :pdf) %>
+<%= link_to "View Receipt", charge_path(@charge, format: :pdf) %>
 ```
 
 ## Invoices
 
-Invoices follow the exact same set of steps as above, with a few minor changes and have a few extra arguments you can use:
-
-* `issue_date` - Date the invoice was issued
-
-* `due_date` - Date the invoice payment is due
-
-* `status` - A status for the invoice (Pending, Paid, etc)
-
-* `bill_to` - A string or Array of lines with billing details
-
-You can also use line_items to flexibly generate and display the table with items in it, including subtotal, taxes, and total amount.
+Invoices follow the exact same set of steps as above. You'll simply want to modify the `details` to include other information for the Invoice such as the Issue Date, Due Date, etc.
 
 ```ruby
-  Receipts::Invoice.new(
-    id: "123",
-    issue_date: Date.today,
-    due_date: Date.today + 30,
-    status: "<b><color rgb='#5eba7d'>PAID</color></b>",
-    bill_to: [
-      "GoRails, LLC",
-      "123 Fake Street",
-      "New York City, NY 10012",
-      nil,
-      "mail@example.com",
-    ],
-    company: {
-      name: "GoRails, LLC",
-      address: "123 Fake Street\nNew York City, NY 10012",
-      email: "support@example.com",
-      logo: File.expand_path("./examples/gorails.png")
-    },
-    line_items: [
-      ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
-      ["GoRails Subscription", "$19.00", "1", "$19.00"],
-      [nil, nil, "Subtotal", "$19.00"],
-      [nil, nil, "Tax Rate", "0%"],
-      [nil, nil, "Total", "$19.00"],
-    ],
-  )
+Receipts::Invoice.new(
+  details: [
+    ["Invoice Number", "123"],
+    ["Issue Date", Date.today.strftime("%B %d, %Y")],
+    ["Due Date", Date.today.strftime("%B %d, %Y")],
+    ["Status", "<b><color rgb='#5eba7d'>PAID</color></b>"]
+  ],
+  recipient: [
+    "<b>Bill To</b>",
+    "Customer",
+    "Address",
+    "City, State Zipcode",
+    "customer@example.org"
+  ],
+  company: {
+    name: "Example, LLC",
+    address: "123 Fake Street\nNew York City, NY 10012",
+    phone: "(555) 867-5309",
+    email: "support@example.com",
+    logo: File.expand_path("./examples/images/logo.png")
+  },
+  line_items: [
+    ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+    ["Subscription", "$19.00", "1", "$19.00"],
+    [nil, nil, "Subtotal", "$19.00"],
+    [nil, nil, "Tax Rate", "0%"],
+    [nil, nil, "Amount Due", "$19.00"]
+  ]
+)
 ```
 
 ## Statements
 
-Statements follow the exact same set of steps as receipts, with a few minor changes and have a few extra arguments you can use:
-
-* `issue_date` - Date the invoice was issued
-
-* `start_date` - The start date of the statement period
-
-* `start_date` - The end date of the statement period
-
-* `bill_to` - A string or Array of lines with account details
-
-You can also use line_items to flexibly generate and display the table with items in it, including subtotal, taxes, and total amount.
+Statements follow the exact same set of steps as above. You'll simply want to modify the `details` to include other information for the Invoice such as the Issue Date, Start and End Dates, etc.
 
 ```ruby
-  Receipts::Statement.new(
-    id: "123",
-    issue_date: Date.today,
-    start_date: Date.today - 30,
-    end_date: Date.today,
-    bill_to: [
-      "GoRails, LLC",
-      "123 Fake Street",
-      "New York City, NY 10012",
-      nil,
-      "mail@example.com",
-    ],
-    company: {
-      name: "GoRails, LLC",
-      address: "123 Fake Street\nNew York City, NY 10012",
-      email: "support@example.com",
-      logo: File.expand_path("./examples/gorails.png")
-    },
-    line_items: [
-      ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
-      ["GoRails Subscription", "$19.00", "1", "$19.00"],
-      [nil, nil, "Subtotal", "$19.00"],
-      [nil, nil, "Tax Rate", "0%"],
-      [nil, nil, "Total", "$19.00"],
-    ],
-  )
+Receipts::Statement.new(
+  details: [
+    ["Statement Number", "123"],
+    ["Issue Date", Date.today.strftime("%B %d, %Y")],
+    ["Period", "#{(Date.today - 30).strftime("%B %d, %Y")} - #{Date.today.strftime("%B %d, %Y")}"]
+  ],
+  recipient: [
+    "<b>Bill To</b>",
+    "Customer",
+    "Address",
+    "City, State Zipcode",
+    "customer@example.org"
+  ],
+  company: {
+    name: "Example, LLC",
+    address: "123 Fake Street\nNew York City, NY 10012",
+    email: "support@example.com",
+    phone: "(555) 867-5309",
+    logo: File.expand_path("./examples/images/logo.png")
+  },
+  line_items: [
+    ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+    ["Subscription", "$19.00", "1", "$19.00"],
+    [nil, nil, "Subtotal", "$19.00"],
+    [nil, nil, "Tax Rate", "0%"],
+    [nil, nil, "Total", "$19.00"]
+  ]
+)
 ```
 
 ## Contributing