spree_invoice 1.1.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,46 @@
+SpreeInvoice
+=======
+This gem provides model responsible for generating pdf from html file.
+
+
+Basic Installation
+------------------
+
+1. Add the following to your Gemfile
+<pre>
+  gem 'spree_invoice', '~> 1.1.0'
+</pre>
+2. Run `bundle install`
+3. To copy and apply migrations run:
+<pre>
+	rails g spree_invoice:install
+</pre>
+
+
+Configuration
+-----
+
+In file config/initializers/spree_invoice.rb please check your configuration for wkhtmltopdf bin path. 
+For more see: [wicked_pdf](https://github.com/mileszs/wicked_pdf)
+
+
+Usage
+-----
+
+1. Print Invoice directly
+<pre>
+	Spree::Invoice.find_by_order_id('some id').try(:generate_pdf)
+</pre>
+2. Print Invoice from order
+<pre>
+	Order.last.invoice.generate_pdf
+</pre>
+3. Print Invoice from User
+<pre>
+	pdfs = []
+	User.last.invoices.each { |e| pdfs << e.generate_pdf }
+</pre>
+
+You can also check how many times invoice was generated - column: counter
+
+Copyright (c) 2012 [Damiano Giacomello], released under the New BSD License

data/app/controllers/spree/invoice_controller.rb

@@ -0,0 +1,23 @@
+module Spree
+  class InvoiceController < Spree::BaseController
+
+    def show
+      order_id = params[:order_id].to_i
+      @order = Order.find_by_id(order_id)
+      @address = @order.bill_address
+      @invoice_print = current_user.has_role?(:admin) ? Spree::Invoice.find_or_create_by_order_id({:order_id => order_id, :user_id => @order ? @order.user_id : nil}) : current_user.invoices.find_or_create_by_order_id(order_id)
+      if @invoice_print
+        respond_to do |format|
+          format.pdf  { send_data @invoice_print.generate_pdf, :filename => "#{@invoice_print.invoice_number}.pdf", :type => 'application/pdf' }
+          format.html { render :file => SpreeInvoice.invoice_template_path.to_s, :layout => false }
+        end
+      else
+        if current_user.has_role?(:admin)
+          return redirect_to(admin_orders_path, :notice => t(:no_such_order_found, :scope => :spree))
+        else
+          return redirect_to(orders_path, :alert => t(:no_such_order_found, :scope => :spree))
+        end
+      end
+    end
+  end
+end

data/app/mailers/spree/order_mailer_decorator.rb

@@ -0,0 +1,18 @@
+module Spree
+  OrderMailer.class_eval do
+    
+    def confirm_email(order, resend = false)
+      if SpreeInvoice.on_confirm_email && !SpreeInvoice.except_payment.include?(order.payment_method.type)
+        inv_print = Spree::Invoice.find_or_create_by_order_id({:order_id => order.id, :user_id => order.user_id})
+        attachments["#{inv_print.invoice_number}.pdf"] = {
+          :content => inv_print.generate_pdf,
+          :mime_type => 'application/pdf'
+        } if inv_print
+      end
+      @order = order
+      subject = (resend ? "[#{t(:resend).upcase}] " : "")
+      subject += "#{Config[:site_name]} #{t('order_mailer.confirm_email.subject')} ##{order.number}"
+      mail(:to => order.email, :subject => subject)
+    end
+  end
+end

data/app/models/spree/invoice.rb

@@ -0,0 +1,42 @@
+module Spree
+  class Invoice < ActiveRecord::Base
+    belongs_to :user
+    belongs_to :order
+    
+    before_create :generate_invoice_number
+    
+    scope :from_current_year, where(["created_at > ? AND created_at < ?", Time.now.at_beginning_of_year, Time.now.at_end_of_year])
+    
+    attr_accessible :user, :order, :order_id, :user_id, :invoice_number, :counter
+
+    def generate_pdf
+      self.update_attribute(:counter, self.counter + 1)
+      WickedPdf.new.pdf_from_string(
+        StaticRender.render_erb(SpreeInvoice.invoice_template_path, {
+          :@order => self.order,
+          :@address => self.order.bill_address,
+          :@invoice_print => self
+        }), {
+          :margin => SpreeInvoice.wkhtmltopdf_margin
+        }
+      )
+    end
+    
+    private
+    def generate_invoice_number
+      write_attribute(:invoice_number, SpreeInvoice.invoice_number_generation_method.call(Spree::Invoice.from_current_year.length + 1))
+    end
+  end
+  
+  class StaticRender < ActionController::Base
+    def self.render_erb(template_path, locals = {})
+      view = ActionView::Base.new(ActionController::Base.view_paths, {})
+      class << view
+        include ApplicationHelper
+        include WickedPdfHelper::Assets
+        include Spree::BaseHelper
+      end
+      view.render(:file => template_path, :locals => locals, :layout => nil)
+    end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,11 @@
+Spree::Order.class_eval do
+  has_one :invoice, :dependent => :destroy
+  after_update :add_invoice
+
+  private
+  def add_invoice
+  	# Only create an invoice if the order is completed!
+  	# And only create it if there is no invoice yet.
+    self.create_invoice(user: user) if self.completed? && self.invoice.blank?
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,3 @@
+Spree::User.class_eval do
+  has_many :invoice
+end

data/app/overrides/add_button_to_admin_panel.rb

@@ -0,0 +1,15 @@
+# Admin Panel buttons
+Deface::Override.new(:virtual_path => %q{spree/admin/orders/index},
+                     :insert_after => "[data-hook='admin_orders_index_header_actions']",
+                     :name => "invoice_print_header",
+                     :text => "<th><%= t(:invoice, :scope => :spree) %></th>")
+
+Deface::Override.new(:virtual_path => %q{spree/admin/orders/index},
+                     :insert_after => "[data-hook='admin_orders_index_row_actions']",
+                     :name => "invoice_print_link",
+                     :text => %q{<td><%= link_to "#{image_tag('admin/icons/receipt.png')} #{t(:show, :scope => :spree)}".html_safe, pdf_invoice_path(:order_id => order.id, :format => :html), :onclick => "window.open(this.href, '#{t(:invoice, :scope => :spree)}', 'width=745,height=892,left=100,top=100,menubar=no,toolbar=yes,scrollbars=yes,location=no,hotkeys=yes'); return false;" %>&nbsp;<%= link_to "#{image_tag('admin/icons/pdf.png')} #{t(:download, :scope => :spree)}".html_safe, pdf_invoice_path(:order_id => order.id, :format => :pdf) %></td>})
+
+Deface::Override.new(:virtual_path => %q{spree/admin/orders/show},
+                     :insert_bottom => "[data-hook='admin_order_show_buttons']",
+                     :name => "invoice_print_show_link",
+                     :text => %q{<%= button_link_to t(:print_invoice, :scope => :spree), pdf_invoice_path(:order_id => @order.id, :format => :pdf), :icon => 'pdf' %>})

data/app/overrides/add_button_to_customer_panel.rb

@@ -0,0 +1,10 @@
+# User Show Account buttons
+Deface::Override.new(:virtual_path => %q{spree/users/show},
+                     :insert_after => "table.order-summary thead tr th:last",
+                     :name => "invoice_print_user_header",
+                     :text => "<th><%= t(:invoice, :scope => :spree) %></th>")
+
+Deface::Override.new(:virtual_path => %q{spree/users/show},
+                     :insert_after => "table.order-summary tbody tr td:last",
+                      :name => "invoice_print_user_link",
+                      :text => %q{<td><%= link_to t(:show, :scope => :spree), pdf_invoice_path(:order_id => order.id, :format => :html), :onclick => "window.open(this.href, '#{t(:invoice, :scope => :spree)}', 'width=745,height=892,left=100,top=100,menubar=no,toolbar=yes,scrollbars=yes,location=no,hotkeys=yes'); return false;" %><%= link_to t(:download, :scope => :spree), pdf_invoice_path(:order_id => order.id, :format => :pdf) %></td>})

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  spree:
+    invoice: Invoice
+    show: show
+    download: PDF
+    print_invoice: Print Invoice
+    no_such_order_found: "No such order found."

data/config/locales/it.yml

@@ -0,0 +1,7 @@
+it:
+  spree:
+    invoice: Fattura
+    show: visualizza
+    download: PDF
+    print_invoice: Stampa fattura
+    no_such_order_found: "Questo ordine non è stato trovato."

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  match '/invoice/show/:order_id' => 'invoice#show', :as => :pdf_invoice
+end

data/db/migrate/20120207124038_create_invoices.rb

@@ -0,0 +1,17 @@
+class CreateInvoices < ActiveRecord::Migration
+  def up
+    create_table :spree_invoices do |t|
+      t.integer :counter, :default => 0      
+      t.string :invoice_number
+
+      t.references :order, :user
+      
+      t.timestamps
+    end
+    add_index :spree_invoice, :invoice_number
+  end
+  
+  def down
+    drop_table :spree_invoice
+  end
+end

data/lib/generators/spree_invoice/install/install_generator.rb

@@ -0,0 +1,44 @@
+module SpreeInvoice
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_invoice'
+      end
+
+      def run_migrations
+         res = ask ">> Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'bundle exec rake db:migrate'
+         else
+           puts ">> Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+
+      def copy_templates_file
+        puts ">> Copy invoice template"
+        copy_file "invoice_template.html.erb", "app/views/spree/invoices/invoice_template.html.erb"
+      end
+
+      def copy_initializer_file
+        puts ">> Copy config file"
+        copy_file "initializer.rb", "config/initializers/spree_invoice.rb"
+        puts "\n>>> Don't forget to check your config file! <<<"
+      end
+      
+      def generate_missing_records
+        res = ask ">> Would you like to run the generating missing orders now? [Y/n]"
+        if res == "" || res.downcase == "y"
+          puts ">> Generating missing records..."
+          run 'bundle exec rake spree_invoice:generate'
+        else
+          puts ">> Skiping rake spree_invoice:generate, don't forget to run it!"
+        end
+      end
+    end
+  end
+end

data/lib/generators/spree_invoice/install/templates/initializer.rb

@@ -0,0 +1,30 @@
+require 'wicked_pdf'
+
+WickedPdf.config = {
+  :exe_path => SpreeInvoice::WKHTMLToPDF.bin_path
+}
+
+SpreeInvoice.setup do |config|
+  config.on_confirm_email = true
+  config.invoice_number_generation_method = lambda { |next_invoice_count|
+        number = "%04d" % next_invoice_count.to_s
+        "R-#{Time.now.year}-#{number}"
+  }
+  
+  config.invoice_template_path = "app/views/spree/invoices/invoice_template.html.erb"
+  config.except_payment = ['Spree::PaymentMethod::Check']
+  config.wkhtmltopdf_margin = {
+    :top    => 10,
+    :bottom => 10,
+    :left   => 15,
+    :right  => 15
+  }
+  config.invoice_seller_details = %Q|
+  Spree Demo
+  P.IVA: 12345678901
+  C.F.: 12345678901
+  Street Address, 12
+  00000 City (STATE)
+  |
+  config.invoice_seller_logo = Spree::Config[:admin_interface_logo]
+end

data/lib/generators/spree_invoice/install/templates/invoice_template.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+</head>
+<body>
+	<div id="wrapper">
+		<div id="header">
+			<%= wicked_pdf_image_tag(SpreeInvoice.invoice_seller_logo) %>
+		</div>
+		<div id="content">
+			<%= SpreeInvoice.invoice_seller_details %><br />
+			<%= @order.id %>
+		</div>
+	</div>
+</body>
+</html>

data/lib/spree_invoice/engine.rb

@@ -0,0 +1,29 @@
+# move it to main file responsible for require
+require File.join(File.dirname(__FILE__), 'wkhtmltopdf')
+
+module SpreeInvoice
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_invoice'
+    
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+    
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+    
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_invoice/railtie.rb

@@ -0,0 +1,10 @@
+require 'spree_invoice'
+require 'rails'
+
+module SpreeInvoice
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require '../tasks/spree_invoice.rake'
+    end
+  end
+end

data/lib/spree_invoice/version.rb

@@ -0,0 +1,3 @@
+module SpreeInvoice
+  VERSION = "1.1.0"
+end

data/lib/spree_invoice/wkhtmltopdf.rb

@@ -0,0 +1,10 @@
+module SpreeInvoice
+
+  module WKHTMLToPDF
+    def self.bin_path
+      bin_path = `which wkhtmltopdf`
+      raise LoadError, "WKHTMLtoPDF not found. Please install it first (http://code.google.com/p/wkhtmltopdf/)" if bin_path.empty?
+      bin_path.gsub(/\n/, '')
+    end
+  end
+end

data/lib/spree_invoice.rb

@@ -0,0 +1,33 @@
+require 'spree_core'
+require 'spree_invoice/engine'
+
+module SpreeInvoice
+  ## CONFIGURATION OPTIONS
+  mattr_accessor :on_confirm_email
+  @@on_confirm_email = true
+  
+  mattr_accessor :invoice_seller_details
+  @@invoice_seller_details = nil
+  
+  mattr_accessor :invoice_seller_logo
+  @@invoice_seller_logo = nil
+  
+  mattr_accessor :invoice_template_path
+  @@invoice_template_path = "app/views/spree/invoices/invoice_template.html.erb"
+  
+  mattr_accessor :except_payment
+  @@except_payment = ['Spree::PaymentMethod::Check']
+  
+  mattr_accessor :wkhtmltopdf_margin
+  @@wkhtmltopdf_margin = {:top    => 10, :bottom => 10, :left   => 15, :right  => 15}
+  
+  mattr_accessor :invoice_number_generation_method
+  @@invoice_number_generation_method = lambda { |next_invoice_count|
+        number = "%04d" % next_invoice_count.to_s
+        "R-#{Time.now.year}-#{number}"
+  }
+  
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/spree_invoice.rake

@@ -0,0 +1,14 @@
+namespace :spree_invoice do
+  desc "Migrating and connecting Spree::Orders with InvoicePrints"
+  task :generate => :environment do
+    sum     = Spree::Order.count
+    counter = 0
+    Spree::Order.all.each do |e| 
+      e.send(:add_invoice)
+      counter += 1
+      print "\r#{counter}/#{sum}"
+    end
+
+    print "\nDone.\n"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: spree_invoice
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Damiano Giacomello
+- Peter Gębala
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wicked_pdf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides invoice pdf generation from a html template via wkhtmltopdf.
+email:
+- damiano.giacomello@diginess.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/generators/spree_invoice/install/install_generator.rb
+- lib/generators/spree_invoice/install/templates/initializer.rb
+- lib/generators/spree_invoice/install/templates/invoice_template.html.erb
+- lib/spree_invoice/engine.rb
+- lib/spree_invoice/railtie.rb
+- lib/spree_invoice/version.rb
+- lib/spree_invoice/wkhtmltopdf.rb
+- lib/spree_invoice.rb
+- lib/tasks/spree_invoice.rake
+- app/assets/images/admin/icons/receipt.png
+- app/controllers/spree/invoice_controller.rb
+- app/mailers/spree/order_mailer_decorator.rb
+- app/models/spree/invoice.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/user_decorator.rb
+- app/overrides/add_button_to_admin_panel.rb
+- app/overrides/add_button_to_customer_panel.rb
+- db/migrate/20120207124038_create_invoices.rb
+- config/locales/en.yml
+- config/locales/it.yml
+- config/routes.rb
+homepage: https://github.com/damianogiacomello/spree_invoice_generator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- wkhtmltopdf
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Spree invoice PDF generation extension.
+test_files: []