solidus_invoice 0.1.0

data/app/jobs/solidus_invoice/invoice_job.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'sunat_invoice'
+
+class SolidusInvoice::InvoiceJob < ApplicationJob
+  queue_as :default
+
+  def perform(*args)
+    opts = args[0]
+    invoice = Spree::Invoice.find(opts[:invoice_id])
+    env = opts[:env]
+
+    sunat_invoice = invoice.build_sunat_invoice
+
+    if invoice.doc_type == '01'
+      # send to SUNAT
+      client = SunatInvoice::InvoiceClient.new(env)
+      response = client.dispatch(sunat_invoice)
+      invoice.update(communicated: true) if response.success?
+    end
+  end
+end

data/app/models/concerns/solidus_invoice/line_item_concern.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  module LineItemConcern
+    extend ActiveSupport::Concern
+
+    def price_excluding_vat
+      (price - (included_tax_total / quantity)).round(2)
+    end
+  end
+end

data/app/models/concerns/solidus_invoice/order_concern.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'solidus_invoice/errors/invalid_serial_error'
+
+module SolidusInvoice
+  module OrderConcern
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :invoices
+      after_save :generate_invoice
+
+      def generate_invoice
+        return unless can_generate_invoice?
+
+        doc_type = bill_address.tax_uid? ? '01' : '03'
+        doc_number = next_correlative(doc_type, store.id)
+
+        # generate Spree::Invoice
+        invoices.create(invoice_serial: get_serial(doc_type, store),
+                        doc_number: doc_number,
+                        order: self)
+      end
+
+      def can_generate_invoice?
+        completed? && paid?
+      end
+
+      def get_serial(doc_type, store = Spree::Store.default)
+        store.invoice_serials.find_by(doc_type: doc_type)
+      end
+
+      # given a store and document type get next posible correlative
+      def next_correlative(doc_type, store_id = Spree::Store.default.id)
+        store = Spree::Store.includes(invoice_serials: :invoices).find(store_id)
+        serial = get_serial(doc_type, store)
+        raise SolidusInvoice::InvalidSerialError unless serial
+
+        current = serial&.invoices&.order(doc_number: :desc)&.first&.doc_number || 0
+        current + 1
+      end
+    end
+  end
+end

data/app/models/concerns/solidus_invoice/shipment_concern.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  module ShipmentConcern
+    extend ActiveSupport::Concern
+
+    def price_excluding_vat
+      (amount - included_tax_total).round(2)
+    end
+  end
+end

data/app/models/concerns/solidus_invoice/store_concern.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  module StoreConcern
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :invoice_serials
+    end
+  end
+end

data/app/models/spree.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spree
+  def self.table_name_prefix
+    'spree_'
+  end
+end

data/app/models/spree/invoice.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'sunat_invoice'
+
+class Spree::Invoice < Spree::Base
+  validates :doc_number, presence: true
+
+  belongs_to :order
+  belongs_to :invoice_serial
+
+  delegate :doc_type, :serial, to: :invoice_serial
+
+  preference :sunat_attributes, :hash
+
+  def sunat_attributes
+    attrs = (preferred_sunat_attributes || {}).dup
+    provider = SunatInvoice::Provider.new(attrs[:provider] || {})
+    attrs[:provider] = provider
+    attrs
+  end
+
+  # return a `SunatInvoice::Invoice`
+  def build_sunat_invoice
+    # generate SunatInvoice::Invoice
+    sunat_invoice = SunatInvoice::Invoice.new(sunat_attributes)
+
+    # add invoice lines from line_items
+    order.line_items.map do |line_item|
+      add_sunat_line(sunat_invoice, line_item)
+    end
+
+    # add invoice lines from shipment
+    order.shipments.map do |shipment|
+      next unless shipment.amount.positive?
+
+      add_sunat_line(sunat_invoice, shipment)
+    end
+
+    # store xml
+    store_xml(sunat_invoice.xml) if respond_to?(:store_xml)
+
+    sunat_invoice
+  end
+
+  # add a new `SunatInvoice::Item` to the given sunat invoice
+  # sunat_invoice => `SunatInvoice::Invoice` instance to add lines
+  # resource => an order's line_item or shipment
+  def add_sunat_line(sunat_invoice, resource)
+    # TODO: handle items with taxes different than vat
+    tax_amount = resource.adjustments.tax.sum(:amount)
+    tax = SunatInvoice::Tax.new(amount: tax_amount, tax_type: :igv)
+    quantity = resource.respond_to?(:quantity) ? resource.quantity : 1
+    item_attrs = {
+      quantity: quantity,
+      price: resource.price_excluding_vat,
+      price_code: '01',
+      taxes: [tax]
+    }
+    sunat_invoice.lines << SunatInvoice::Item.new(item_attrs)
+  end
+end

data/app/models/spree/invoice_serial.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Spree::InvoiceSerial < Spree::Base
+  validates :serial, presence: true, uniqueness: { scope: :store_id }
+  validates :store_id, presence: true
+
+  belongs_to :store
+  has_many :invoices
+end

data/app/overrides/spree/line_item_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spree::LineItemOverride
+  Spree::LineItem.include SolidusInvoice::LineItemConcern
+end

data/app/overrides/spree/order_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spree::OrderOverride
+  Spree::Order.include SolidusInvoice::OrderConcern
+end

data/app/overrides/spree/shipment_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spree::ShipmentOverride
+  Spree::Shipment.include SolidusInvoice::ShipmentConcern
+end

data/app/overrides/spree/store_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spree::StoreOverride
+  Spree::Store.include SolidusInvoice::StoreConcern
+end

data/bin/rails

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/solidus_invoice/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/db/migrate/20191107042751_create_spree_invoices.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateSpreeInvoices < ActiveRecord::Migration[6.0]
+  def change
+    create_table :spree_invoices do |t|
+      t.integer :doc_number
+      t.integer :order_id
+      t.integer :invoice_serial_id
+      t.boolean :communicated, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20191115204118_create_spree_invoice_serials.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateSpreeInvoiceSerials < ActiveRecord::Migration[6.0]
+  def change
+    create_table :spree_invoice_serials do |t|
+      t.string :serial
+      t.integer :store_id
+      t.string :doc_type
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20191205205004_add_tax_uid_to_spree_addresses.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddTaxUidToSpreeAddresses < ActiveRecord::Migration[6.0]
+  def change
+    add_column :spree_addresses, :tax_uid, :string
+  end
+end

data/db/migrate/20191223173229_add_preferences_to_spree_invoices.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddPreferencesToSpreeInvoices < ActiveRecord::Migration[6.0]
+  def change
+    add_column :spree_invoices, :preferences, :text
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_invoice'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_invoice.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_invoice/engine'

data/lib/solidus_invoice/engine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_invoice'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/overrides/**/*_override*.rb')) do |c|
+        require_dependency(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_invoice/errors/invalid_serial_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  class InvalidSerialError < StandardError
+  end
+end

data/lib/solidus_invoice/factories.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :invoice, class: 'Spree::Invoice' do
+    doc_number { rand(450) }
+    order
+    invoice_serial
+
+    factory :invoice_with_serial do
+      before(:create) do |invoice|
+        store = create(:store)
+        invoice.invoice_serial { create(:invoice_serial, store: store) }
+      end
+    end
+  end
+
+  factory :invoice_serial, class: 'Spree::InvoiceSerial' do
+    store
+    doc_type { '03' }
+    serial { 'B023' }
+  end
+
+  factory :provider, class: 'SunatInvoice::Provider' do
+    signature_id { 'signatureST' }
+    signature_location_id { 'signQWI3' }
+    ruc { '20100454523' }
+    name { 'MY BUSINESS' }
+  end
+
+  factory :customer, class: 'SunatInvoice::Customer' do
+    ruc { '20293028401' }
+    name { 'SOME BUSINESS' }
+  end
+end

data/lib/solidus_invoice/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/solidus_invoice/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusInvoice
+  VERSION = '0.1.0'
+end

data/lib/tasks/solidus_invoice_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :solidus_invoice do
+#   # Task goes here
+# end

data/solidus_invoice.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+$:.push File.expand_path('lib', __dir__)
+require 'solidus_invoice/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'solidus_invoice'
+  s.version     = SolidusInvoice::VERSION
+  s.summary     = 'generate invoice documents for solidus orders'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.author      = 'César Carruitero'
+  s.email       = 'ccarruitero@protonmail.com'
+  s.homepage    = 'https://github.com/ccarruitero/solidus_invoice'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency 'solidus_core'
+  s.add_dependency 'solidus_support'
+  s.add_dependency 'sunat_invoice'
+
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_bot'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'shoulda-matchers'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end