good_receipt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a4f2c955fc805eb006bb97a9c136c81a8bf197a2c808dfe2c696f2b10da80bf
+  data.tar.gz: 16e276be9bad452712df8bece0918fb61f869f4e8f08623e74fc31a57a875590
+SHA512:
+  metadata.gz: e34061d4101b24604e6c54e611a088917f858916a4a9759f688fcb1cdacf7cae8290a098a3fd9f993af070b8f9a04a03d95821623636be90bd3983d94af1375a
+  data.tar.gz: d6674b42a1df209119dac673b7d4a2c86802dc6acfc0fb2184b635ae873dbc1bb48d6b384487ffb3c73913841d39fde80b4f0f19328153b65c5012a9dc41805c

data/lib/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'google-cloud-storage'
+gem 'prawn'
+gem 'prawn-table'

data/lib/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    declarative (0.0.20)
+    declarative-option (0.1.0)
+    digest-crc (0.6.1)
+      rake (~> 13.0)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.32.1)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.10.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mini_mime (~> 1.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.10)
+    google-cloud-core (1.3.2)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.2.1)
+      faraday (~> 0.11)
+    google-cloud-storage (1.21.1)
+      addressable (~> 2.5)
+      digest-crc (~> 0.4)
+      google-api-client (~> 0.26)
+      google-cloud-core (~> 1.2)
+      googleauth (>= 0.6.2, < 0.10.0)
+      mini_mime (~> 1.0)
+    googleauth (0.9.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    httpclient (2.8.3)
+    jwt (2.2.2)
+    memoist (0.16.2)
+    mini_mime (1.0.2)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    os (1.1.1)
+    pdf-core (0.7.0)
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    ttfunk (1.5.1)
+    uber (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  google-cloud-storage
+  prawn
+  prawn-table
+
+BUNDLED WITH
+   2.4.19

data/lib/good_receipt/base.rb

@@ -0,0 +1,210 @@
+require 'prawn'
+require 'prawn/table'
+require_relative 'constants'
+require_relative 'index'
+
+module GoodReceipt
+  class Configuration
+    attr_accessor :business_name, :business_phone, :business_email, :storage_bucket, :storage_project_id,
+                  :storage_credentials, :logo_path
+
+    def initialize
+      @business_name = 'Business Name'
+      @business_phone = '(000) 111-1234'
+      @business_email = 'email@email.com'
+      @storage_project_id = 'google-cloud-project'
+      @storage_bucket = 'google-cloud-bucket-name'
+      @storage_credentials = '/path/to/credentials'
+      @logo_path = nil
+    end
+  end
+
+  class ReceiptError < StandardError; end
+
+  class ReceiptDataError < ReceiptError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def initialize
+    @configuration = self.class.configuration
+  end
+
+  class Base
+    private
+
+    def pdf
+      @pdf ||= setup_pdf
+    end
+
+    def header_info_column(data)
+      pdf.make_table(data, cell_style: { border_width: 0 }) do
+        cells.style(size: 34)
+        cells.style do |c|
+          if (c.row % 2).zero?
+            c.text_color = Constants::COLOR_GRAY
+          else
+            c.font_style = :bold
+            c.padding_bottom = 15
+          end
+        end
+      end
+    end
+
+    def header(title, data)
+      data = data.map { |col| col.map { |item| [item] } }
+      col1 = header_info_column(data[0])
+      col2 = pdf.make_table(data[1], position: :right, cell_style: { border_width: 0 }) do
+        cells.style(size: 35, align: :right)
+      end
+
+      pdf.table(
+        [
+          [title, '', { image: GoodReceipt.configuration&.logo_path || './images/main.png', position: :right }],
+          [col1, '', col2]
+        ],
+        width: pdf.bounds.width,
+        cell_style: { border_width: 0 }
+      ) do
+        row(0).font_style = :bold
+        row(0).size = 59
+        row(0).text_color = Constants::COLOR_DEFAULT
+      end
+
+      pdf.move_down 80
+    end
+
+    def report_header(title, meta_info)
+      if GoodReceipt.configuration.nil?
+        raise StandardError, 'Configuration not set. Please call GoodReceipt.configure to set the configuration.'
+      end
+
+      dt = meta_info[:date] || Time.now.getlocal('-06:00').strftime('%Y-%m-%d %I:%M%P').to_s
+
+      header(
+        title,
+        [
+          [
+            'Customer Name', meta_info[:customer_name],
+            'Date', dt
+          ],
+          [
+            GoodReceipt.configuration.business_name, GoodReceipt.configuration.business_phone, GoodReceipt.configuration.business_email
+          ]
+        ]
+      )
+    end
+
+    def space(height = 30)
+      pdf.move_down height
+    end
+
+    def hr_line
+      pdf.stroke do
+        pdf.stroke_color Constants::COLOR_DEFAULT
+        pdf.line_width 10
+        pdf.stroke_horizontal_rule
+      end
+      space
+    end
+
+    def section_title(text, underline: false)
+      pdf.text text, size: 60, color: Constants::COLOR_DEFAULT
+      space
+      hr_line if underline
+    end
+
+    def list(data, text_color: Constants::COLOR_DEFAULT)
+      pdf.table(data, width: pdf.bounds.width, cell_style: { inline_format: true }) do
+        cells.size = 39
+        cells.borders = [:bottom]
+        cells.border_color = Constants::COLOR_TABLE_BORDER
+        cells.border_width = 4
+        cells.padding_bottom = 20
+        cells.padding_top = 50
+        cells.font_style = :bold
+
+        columns(0).text_color = text_color
+        columns(0).padding_left = 30
+        columns(1).text_color = Constants::COLOR_GRAY
+        columns(1).padding_right = 30
+        columns(1).align = :right
+      end
+
+      space
+    end
+
+    def conditions_list(data, text_color: Constants::COLOR_DEFAULT)
+      hr_line
+
+      pdf.table(data, width: pdf.bounds.width, cell_style: { inline_format: true }) do
+        cells.size = 30
+        cells.borders = [:bottom]
+        cells.border_color = Constants::COLOR_TABLE_BORDER
+        cells.border_width = 4
+        cells.padding_bottom = 20
+        cells.padding_top = 50
+        cells.font_style = :bold
+
+        columns(0).text_color = text_color
+        columns(0).padding_left = 30
+        columns(1).text_color = Constants::COLOR_GRAY
+        columns(1).padding_right = 30
+        columns(1).align = :right
+        columns(2).align = :right
+        columns(3).align = :right
+      end
+    end
+
+    def price_table(data)
+      cols = data.first.count
+      last_col = cols - 1
+      pdf.table(data, width: pdf.bounds.width, cell_style: { inline_format: true }) do
+        cells.size = 39
+        cells.borders = [:bottom]
+        cells.border_color = Constants::COLOR_TABLE_BORDER
+        cells.border_width = 4
+        cells.padding_bottom = 20
+        cells.padding_top = 50
+        cells.text_color = Constants::COLOR_GRAY
+
+        row(0).font_style = :bold
+
+        column(0).font_style = :bold
+        column(0).text_color = Constants::COLOR_DEFAULT
+        column(0).padding_left = 30
+
+        column(1..last_col).align = :right
+        column(1..last_col).width = 350
+
+        column(last_col).padding_right = 30
+        column(last_col).font_style = :bold
+
+        row(0).text_color = Constants::COLOR_BLACK
+        row(0).border_color = Constants::COLOR_BLACK
+      end
+      pdf.move_down 80
+    end
+
+    def setup_pdf
+      pdf = Prawn::Document.new(
+        page_size: [2480, 3508],
+        margin: [140, 180]
+      )
+      pdf.font_families.update('AvenirNext' => {
+                                 normal: './fonts/AvenirNext/regular.ttf',
+                                 bold: './fonts/AvenirNext/bold.ttf',
+                                 italic: './fonts/AvenirNext/italic.ttf'
+                               })
+
+      pdf.font 'AvenirNext'
+      pdf
+    end
+  end
+end

data/lib/good_receipt/constants.rb

@@ -0,0 +1,10 @@
+module Constants
+  COLOR_DEFAULT = 'FFA500'
+  COLOR_RED = 'E35555'
+  COLOR_GREEN = '4DA63D'
+  COLOR_YELLOW = 'FFE83D'
+  COLOR_GRAY = '888888'
+  COLOR_BLACK = '000000'
+  COLOR_TABLE_BORDER = 'EEEEEE'
+  COLOR_WHITE = '4D92DF'
+end

data/lib/good_receipt/index.rb

@@ -0,0 +1,6 @@
+require 'date'
+require 'json'
+require 'net/http'
+require 'prawn'
+require 'prawn/table'
+require 'uri'

data/lib/good_receipt/receipt.rb

@@ -0,0 +1,119 @@
+require_relative 'index'
+require_relative 'base'
+require 'google/cloud/storage'
+
+module GoodReceipt
+  class Receipt < Base
+    def initialize(data)
+      super()
+      validate_data(data)
+      @data = data
+    end
+
+    def table_items
+      items = [
+        ['Description', 'Qty', 'Unit Price', 'Line Total']
+      ]
+
+      @data[:line_items].each do |line_item|
+        items << [line_item[:name], '', '', '']
+
+        total = 0.0
+
+        line_item[:items].each do |item|
+          total += item[:price].to_f
+          items << [item[:name], item[:quantity], "$#{item[:price]}",
+                    "$#{(item[:price] * item[:quantity]).to_f.round(2)}"]
+        end
+
+        items << ['', '', '', "$#{total.round(2)}"]
+      end
+
+      items << ['', '', 'Discount', "- $#{@data[:discount].to_f.round(2)}"] if @data[:discount]
+
+      items << ['', '', 'Tax', "$#{@data[:tax]}"] if @data[:tax]
+
+      items << ['', '', 'Total Price', "$#{@data[:total_price]}"]
+    end
+
+    def paid_line
+      pdf.table(
+        [
+          ['', 'PAID']
+        ],
+        width: pdf.bounds.width,
+        cell_style: { border_width: 0 }
+      ) do
+        column(0).size = 40
+
+        column(1).align = :right
+        column(1).size = 70
+        column(1).text_color = Constants::COLOR_GREEN
+        column(1).font_style = :bold
+        column(1).padding_right = 50
+      end
+    end
+
+    def generate
+      # Render PDF
+      report_header(
+        'Receipt',
+        {
+          customer_name: @data[:customer_name],
+          date: @data[:date]
+        }
+      )
+      price_table(table_items)
+      paid_line
+
+      # Save PDF into the file
+      path_name = "receipt-#{@data[:id]}.pdf"
+      pdf.render_file path_name
+
+      # Store PDF into the Google Cloud Storage
+      storage = ::Google::Cloud::Storage.new(
+        project_id: GoodReceipt.configuration.storage_project_id,
+        credentials: GoodReceipt.configuration.storage_credentials
+      )
+
+      bucket = storage.bucket GoodReceipt.configuration.storage_bucket
+      file = bucket.create_file path_name, "/#{@id}/receipt.pdf"
+      file.acl.public!
+
+      # Return the URL of the PDF
+      file.url
+    end
+
+    private
+
+    def validate_data(data)
+      raise ReceiptDataError, "Invalid data format: #{data.inspect}. Data must be a hash." unless data.is_a?(Hash)
+      raise ReceiptDataError, "Invalid data format: #{data.inspect}" unless valid_data?(data)
+    end
+
+    def valid_data?(data)
+      expected_keys = %i[line_items customer_name discount total_price date id]
+      unless expected_keys.all? { |key| data.key?(key) }
+        raise ReceiptDataError,
+              "Missing or invalid key(s) in data: #{data.keys.inspect}. Expected keys: #{expected_keys.inspect}"
+      end
+
+      unless valid_line_items?(data[:line_items])
+        raise ReceiptDataError,
+              "Invalid format in line_items: #{data[:line_items].inspect}. Each item should be a hash with :name and :items keys."
+      end
+
+      true
+    end
+
+    def valid_line_items?(line_items)
+      unless line_items.is_a?(Array) &&
+             line_items.all? { |item| item.is_a?(Hash) && item.key?(:name) && item.key?(:items) }
+        raise ReceiptDataError,
+              "Invalid format in line_items: #{line_items.inspect}. Each item should be a hash with :name and :items keys."
+      end
+
+      true
+    end
+  end
+end

data/lib/good_receipt/version.rb

@@ -0,0 +1,3 @@
+module GoodReceipt
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: good_receipt
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Robenalt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.1
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: This gem provides functionality for creating and managing receipts in
+  Ruby applications. It uses the Prawn gem for generation, and then uses the Google
+  Cloud Storage gem to send the generated receipts to the cloud.
+email:
+- srob0722@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/Gemfile
+- lib/Gemfile.lock
+- lib/example/receipt-1.pdf
+- lib/fonts/AvenirNext/bold.ttf
+- lib/fonts/AvenirNext/italic.ttf
+- lib/fonts/AvenirNext/regular.ttf
+- lib/good_receipt/base.rb
+- lib/good_receipt/constants.rb
+- lib/good_receipt/index.rb
+- lib/good_receipt/receipt.rb
+- lib/good_receipt/version.rb
+- lib/images/main.png
+homepage: https://github.com/seanrobenalt/good_receipt
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Lightweight Ruby gem for generating and managing good receipt PDFs for your
+  business.
+test_files: []