receipts 0.2.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42fd5e58ab95cd832a64807adf73afa1e9756316190dbe4819d0d0c634875c01
-  data.tar.gz: 1295e9bc817000ef60a9b63112429716febd07e316d07cd8da164d4771622952
+  metadata.gz: 225c91cdad16636a1e15291e308eedce0d9e47c27e9fd831ab1a3870e2fe208d
+  data.tar.gz: a92e20ae450a54d5f78ce44955e8a20c14b672f740e41b6e877a328e8deee9ff
 SHA512:
-  metadata.gz: d3bbc34ddee5fef59da9cbc2f5a8107a5ee1635a23e77241b42ac9e2f0d7a844db3a19e78603865e62be7adc58442c89e5ff0dc483bb1807e9113dd885acd330
-  data.tar.gz: 9ee6b9e94669033b9a21a3fb9c064353ce2e24881caf5b5964a6639f3daf88df52b25ce054dabbd9c84b670615eb981e1684cd8c03c3139ac395b6d30d2143da
+  metadata.gz: 2a25e8b39b2f534353d7f4afe84169f31e76add4d709ca98c441f57f94b9b35e663c91854c8f77ab19d1ef7a880bc9a23d9e5b1194642d5a4b2d8ca400a82b02
+  data.tar.gz: 562bc42aacd3aea8f84e1ff23dd7b7d3da86cf8eb196679dad60e5621f5180a9b456c914a1d7519aba19fd77100ccc19e9d04c468efa582315c7548f8ffe4c79

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [excid3] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

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
 
@@ -60,12 +60,13 @@ class Charge < ActiveRecord::Base
   def receipt
     Receipts::Receipt.new(
       id: id,
+      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],
@@ -104,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*
 
@@ -169,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,10 +48,14 @@ module Receipts
       def header
         move_down 60
 
-        if company.has_key? :logo
-          image open(company.fetch(:logo)), height: 32
-        else
+        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
@@ -66,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.2"
+  VERSION = "1.0.3"
 end

data/receipts.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
 
   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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,20 @@ 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
@@ -107,14 +121,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 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
@@ -124,7 +143,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.
 test_files: