receipts 0.2.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0466ac55f2ba9f07b0caac72cc9785a78ef44a0ce8ba507d9c8bb1ed81675a6
-  data.tar.gz: d8daa107a52b0cfe63af6c8f1b927e0e590dd80a316893ce984a0a14f7d98829
+  metadata.gz: aa3e56021ccff37e48f340cea424f548b1f52c6782203cde1002049a1f470571
+  data.tar.gz: db562a59a36abcc235718f59420bc730ddcb70a3b057536df824692cfbfd4909
 SHA512:
-  metadata.gz: 560016286cb1ea373742c3f855b8cb8677f0fb74ac4cfc90808f54efbca8955902f4775012697d2a0b85b8637bb3158d2250893745eaf6eb4b87fb011a7484ef
-  data.tar.gz: f07a19f5860698341e9edddf96872297016c63fbc2a31c1d2c9cb2980ca69ebb98603aae6b020e0cb77e5bb18f2aa198a03859796221cf64fc66747c8276a2a0
+  metadata.gz: a2ed85aa3947b15ca345d01b88e9f267335e181ef4a8950b496cd99c4d9c9187844d92f993b82dfc3018ece6dcee9765777842135d330dbe61e08599676b43d8
+  data.tar.gz: 9d2c8edb71e5d0204431f2053bb1a8518a8e766201950327c0581c8c4914d7edee96ea1f435ee9dd4c800d687886f79dcc6e97596a0cd689fadf6b827d30dcd9

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### 1.0.3
+
+* [FIX] Fixes typo introduced in 1.0.2
+
+### 1.0.2
+
+* [NEW] Add ability to specify file-like objects for logo
+
+### 1.0.1
+
+* [FIX] Make tables full width
+
+### 1.0.0
+
+* [NEW] Invoices!

data/README.md

@@ -4,7 +4,7 @@
 
 Receipts for your Rails application that works with any payment provider.
 
-Check out an [example PDF receipt](https://github.com/excid3/receipts/blob/master/examples/receipt.pdf?raw=true)
+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.
 
 ## Installation
 
@@ -63,10 +63,10 @@ class Charge < ActiveRecord::Base
       subheading: "RECEIPT FOR CHARGE #%{id}",
       product: "GoRails",
       company: {
-        name: "One Month, Inc.",
-        address: "37 Great Jones\nFloor 2\nNew York City, NY 10012",
-        email: "teachers@onemonth.com",
-        logo: Rails.root.join("app/assets/images/one-month-dark.png")
+        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],
@@ -105,11 +105,25 @@ Company consists of several required nested attributes.
   * `name` - **Required**
   * `address` - **Required**
   * `email` - **Required**
+  * `line_items` - **Required**
+
+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` - *Optional*
 
-* `line_items` - **Required**
+The logo must be either a string path to a file or a file-like object.
 
-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.
+```ruby
+logo: Rails.root.join("app/assets/images/logo.png")
+# or
+logo: File.open("app/assets/images/logo.png", "rb")
+```
+
+To use an image from a URL, we recommend using `open-uri` to open the remote file as a StringIO object.
+
+`require 'open-uri'`
+
+`logo: URI.open("https://www.ruby-lang.org/images/header-ruby-logo@2x.png")`
 
 * `font` - *Optional*
 
@@ -170,9 +184,52 @@ resources :charges
 <%= link_to "Download 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.
+
+```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"],
+    ],
+  )
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/receipts/fork )
+1. Fork it ( https://github.com/excid3/receipts/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`)

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+require "open-uri"
 
 RSpec::Core::RakeTask.new('spec')
 
@@ -10,3 +11,60 @@ task :test => :spec
 task :console do
   exec "irb -r receipts -I ./lib"
 end
+
+task :receipt do
+  require "./lib/receipts"
+
+  Receipts::Receipt.new(
+    id: "123",
+    subheading: "RECEIPT FOR CHARGE #1",
+    product: "GoRails",
+    company: {
+      name: "GoRails, LLC",
+      address: "123 Fake Street\nNew York City, NY 10012",
+      email: "support@example.com",
+      logo: URI.open("https://www.ruby-lang.org/images/header-ruby-logo@2x.png")
+    },
+    line_items: [
+      ["Date",           Time.now.to_s],
+      ["Account Billed", "Example User (user@example.com)"],
+      ["Product",        "GoRails"],
+      ["Amount",         "$19.00"],
+      ["Charged to",     "Visa (**** **** **** 1234)"],
+      ["Transaction ID", "123456"]
+    ],
+  ).render_file "examples/receipt.pdf"
+end
+
+task :invoice do
+  require "./lib/receipts"
+
+  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",
+      "Address",
+      "City, State Zipcode",
+      nil,
+      "mail@example.com",
+    ],
+    company: {
+      name: "GoRails, LLC",
+      address: "123 Fake Street\nNew York City, NY 10012",
+      email: "support@example.com",
+      #logo: Rails.root.join("app/assets/images/gorails.png")
+      #logo: File.expand_path("./examples/gorails.png")
+      logo: File.open("./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, "Amount Due", "$19.00"],
+    ],
+  ).render_file "examples/invoice.pdf"
+end

data/lib/receipts.rb

@@ -1,2 +1,3 @@
 require "receipts/version"
 require "receipts/receipt"
+require "receipts/invoice"

data/lib/receipts/invoice.rb

@@ -0,0 +1,125 @@
+require 'prawn'
+require 'prawn/table'
+
+module Receipts
+  class Invoice < Prawn::Document
+    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading, :bill_to, :issue_date, :due_date, :status
+
+    def initialize(attributes)
+      @attributes  = attributes
+      @id          = attributes.fetch(:id)
+      @company     = attributes.fetch(:company)
+      @line_items  = attributes.fetch(:line_items)
+      @custom_font = attributes.fetch(:font, {})
+      @message     = attributes.fetch(:message) { default_message }
+      @subheading  = attributes.fetch(:subheading) { default_subheading }
+      @bill_to     = Array(attributes.fetch(:bill_to)).join("\n")
+      @issue_date  = attributes.fetch(:issue_date)
+      @due_date    = attributes.fetch(:due_date)
+      @status      = attributes.fetch(:status)
+
+      super(margin: 0)
+
+      setup_fonts if custom_font.any?
+      generate
+    end
+
+    private
+
+      def default_message
+        "For questions, contact us anytime at <color rgb='326d92'><link href='mailto:#{company.fetch(:email)}?subject=Charge ##{id}'><b>#{company.fetch(:email)}</b></link></color>."
+      end
+
+      def default_subheading
+        "INVOICE #%{id}"
+      end
+
+      def setup_fonts
+        font_families.update "Primary" => custom_font
+        font "Primary"
+      end
+
+      def generate
+        bounding_box [0, 792], width: 612, height: 792 do
+          bounding_box [85, 792], width: 442, height: 792 do
+            header
+            charge_details
+            footer
+          end
+        end
+      end
+
+      def header
+        move_down 60
+
+        logo = company[:logo]
+
+        if logo.nil?
+          move_down 32
+        elsif logo.is_a?(String)
+          image open(logo), height: 32
+        else
+          image logo, height: 32
+        end
+
+        move_down 8
+        label (subheading % {id: id})
+
+        move_down 10
+
+        # Cache the Y value so we can have both boxes at the same height
+        top = y
+        bounding_box([0, y], width: 200) do
+          label "BILL TO"
+
+          move_down 5
+          text_box bill_to, at: [0, cursor], width: 200, height: 75, inline_format: true, size: 10, leading: 4, overflow: :shrink_to_fit
+
+        end
+
+        bounding_box([250, top], width: 200) do
+          label "INVOICE DATE"
+
+          move_down 5
+          text issue_date.to_s, inline_format: true, size: 12, leading: 4
+
+          move_down 10
+          label "DUE DATE"
+
+          move_down 5
+          text due_date.to_s, inline_format: true, size: 12, leading: 4
+
+          move_down 10
+          label "STATUS"
+
+          move_down 5
+          text status, inline_format: true, size: 12, leading: 4
+        end
+      end
+
+      def charge_details
+        move_down 30
+
+        borders = line_items.length - 2
+
+        table(line_items, width: bounds.width, cell_style: { border_color: 'cccccc', inline_format: true }) do
+          cells.padding = 12
+          cells.borders = []
+          row(0..borders).borders = [:bottom]
+        end
+      end
+
+      def footer
+        move_down 30
+        text message, inline_format: true, size: 12, leading: 4
+
+        move_down 30
+        text company.fetch(:name), inline_format: true
+        text "<color rgb='888888'>#{company.fetch(:address)}</color>", inline_format: true
+      end
+
+      def label(text)
+        text "<color rgb='a6a6a6'>#{text}</color>", inline_format: true, size: 8
+      end
+  end
+end

data/lib/receipts/receipt.rb

@@ -48,12 +48,14 @@ module Receipts
       def header
         move_down 60
 
-        logo_path = company.fetch(:logo, '')
+        logo = company[:logo]
 
-        if logo_path.empty?
+        if logo.nil?
           move_down 32
+        elsif logo.is_a?(String)
+          image open(logo), height: 32
         else
-          image open(logo_path), height: 32
+          image logo, height: 32
         end
 
         move_down 8
@@ -68,7 +70,7 @@ module Receipts
 
         borders = line_items.length - 2
 
-        table(line_items, cell_style: { border_color: 'cccccc' }) do
+        table(line_items, width: bounds.width, cell_style: { border_color: 'cccccc', inline_format: true }) do
           cells.padding = 12
           cells.borders = []
           row(0..borders).borders = [:bottom]

data/lib/receipts/version.rb

@@ -1,3 +1,3 @@
 module Receipts
-  VERSION = "0.2.3"
+  VERSION = "1.0.4"
 end

data/receipts.gemspec

@@ -25,5 +25,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'prawn', '>= 1.3.0', '< 3.0.0'
   spec.add_dependency 'prawn-table', '~> 0.2.1'
-  spec.add_dependency 'ttfunk', '~> 1.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
-- !ruby/object:Gem::Dependency
-  name: ttfunk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
 description: Receipts for your Rails application that works with any payment provider.
 email:
 - excid3@gmail.com
@@ -124,12 +110,16 @@ files:
 - ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/gorails.png
+- examples/invoice.pdf
 - examples/receipt.pdf
 - lib/receipts.rb
+- lib/receipts/invoice.rb
 - lib/receipts/receipt.rb
 - lib/receipts/version.rb
 - receipts.gemspec
@@ -154,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.