receipts 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0877b9dcbd189ff86a0ab1f19c2635f1842be92a0490d33e1ad2276c201a11b0'
-  data.tar.gz: a5bbe668f1945390a64ff96ffd01c09b9b42bd2d68c8e4169a0d2209affaf9e0
+  metadata.gz: 7437916678e9856f57b022945c52fb49c3004bc929e77ec2c2d96b049b9231bc
+  data.tar.gz: 6a5b02fcf9aba5fc5e1e0060acc1403bfe47674f68e9453b3162064181eeb888
 SHA512:
-  metadata.gz: 300e387def1da02f4da69aebdb9a7e891ad35a5236a25889a9af06945f7ee9dac4ce50c6d10d45ad9faa3b38c61460025b22558ce5b9c7643c332c8aa51e0f0f
-  data.tar.gz: 0bede300b10b2c9bcc53cfccec438aca595f0b7a19ba673fb83851f7c2e56a313e609ee94f4896d072d54c99fe82e3b0fde28fa7832bff27e89fa45cc8186d81
+  metadata.gz: f1685c620c7b21433644ffc6bd153ad0e3f008751f02fe8b888acbec7da03ebba1f0088804742f2b5d71aa46c713fd523655c15eda7a726ff0fe92111ab4f623
+  data.tar.gz: efd79f9bd4fb9a8e188dff1b149dc1d267d7eb5ca0c38124c976d9b142428c9998927948b6ed57825b8b1ec2f8f8cd8aa54237f6a226f6d0094f4464bfd566df

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### Unreleased
+
+### 1.1.0
+
+* [NEW] Add Statements - @anquinn
+
+### 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

@@ -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*
 
@@ -182,7 +196,7 @@ Invoices follow the exact same set of steps as above, with a few minor changes a
 
 * `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. 
+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(
@@ -192,8 +206,51 @@ You can also use line_items to flexibly generate and display the table with item
     status: "<b><color rgb='#5eba7d'>PAID</color></b>",
     bill_to: [
       "GoRails, LLC",
-      "Address",
-      "City, State Zipcode",
+      "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"],
+    ],
+  )
+```
+
+## 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.
+
+```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",
     ],
@@ -215,7 +272,7 @@ You can also use line_items to flexibly generate and display the table with item
 
 ## 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')
 
@@ -22,7 +23,7 @@ task :receipt do
       name: "GoRails, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
       email: "support@example.com",
-      logo: File.expand_path("./examples/gorails.png")
+      logo: URI.open("https://www.ruby-lang.org/images/header-ruby-logo@2x.png")
     },
     line_items: [
       ["Date",           Time.now.to_s],
@@ -54,7 +55,9 @@ task :invoice do
       name: "GoRails, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
       email: "support@example.com",
-      logo: File.expand_path("./examples/gorails.png")
+      #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>"],
@@ -65,3 +68,34 @@ task :invoice do
     ],
   ).render_file "examples/invoice.pdf"
 end
+
+task :statement do
+  require "./lib/receipts"
+
+  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"],
+    ],
+  ).render_file "examples/statement.pdf"
+end

data/lib/receipts.rb

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

data/lib/receipts/invoice.rb

@@ -52,12 +52,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
@@ -100,7 +102,7 @@ module Receipts
 
         borders = line_items.length - 2
 
-        table(line_items, cell_style: { border_color: 'cccccc', inline_format: true }) 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/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', inline_format: true }) 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/statement.rb

@@ -0,0 +1,117 @@
+require 'prawn'
+require 'prawn/table'
+
+module Receipts
+  class Statement < Prawn::Document
+    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading, :bill_to, :issue_date, :start_date, :end_date
+
+    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)
+      @start_date  = attributes.fetch(:start_date)
+      @end_date    = attributes.fetch(:end_date)
+
+      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
+        "STATEMENT #%{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
+          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 "STATEMENT DATE"
+
+          move_down 5
+          text issue_date.to_s, inline_format: true, size: 12, leading: 4
+
+          move_down 10
+          label "STATEMENT PERIOD"
+
+          move_down 5
+          text "#{start_date.to_s} - #{end_date.to_s}", 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/version.rb

@@ -1,3 +1,3 @@
 module Receipts
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 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: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2021-05-25 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
@@ -132,9 +118,11 @@ files:
 - examples/gorails.png
 - examples/invoice.pdf
 - examples/receipt.pdf
+- examples/statement.pdf
 - lib/receipts.rb
 - lib/receipts/invoice.rb
 - lib/receipts/receipt.rb
+- lib/receipts/statement.rb
 - lib/receipts/version.rb
 - receipts.gemspec
 - spec/receipts_spec.rb
@@ -143,7 +131,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.
 test_files: