spree_zaez_billet 3.0.0 → 3.0.1

data/app/controllers/spree/billets_controller.rb

@@ -0,0 +1,35 @@
+class Spree::BilletsController < Spree::StoreController
+
+  before_action :load_data, only: :show
+
+  def show
+    if @billet.due_date.past?
+      # voids the old payment
+      old_payment = @billet.payment
+      old_payment.void_transaction!
+
+      # creates the new payment
+      params = {order: @billet.order,
+                amount: old_payment.amount,
+                payment_method: @billet.payment_method,
+                source_attributes: {order: @billet.order,
+                                    user: @billet.user,
+                                    status: 'pending'}}
+      new_payment = Spree::Payment.new(params)
+      new_payment.pend!
+      new_payment.process!
+
+      @billet = new_payment.source
+    end
+    # generate the billet document
+    @document = @billet.generate_document
+    send_data @document.to_pdf, filename: "boleto_#{@billet.order.number}.pdf"
+  end
+
+  private
+
+  def load_data
+    @billet = Spree::Billet.find params[:id] || params[:billet_id]
+  end
+
+end

data/app/models/spree/address_decorator.rb

@@ -0,0 +1,17 @@
+Spree::Address.class_eval do
+
+  # Return full address in same string
+  #
+  # @author Isabella Santos
+  #
+  # @return [String]
+  #
+  def full_address
+    full = address1
+    full << ", #{address2}" if address2.present?
+    full << " - #{zipcode}" if zipcode.present?
+    full << " - #{city}" if city.present?
+    full << "/#{state.abbr}" if state.present?
+    full
+  end
+end

data/app/models/spree/billet.rb

@@ -0,0 +1,257 @@
+module Spree
+  class Billet < ActiveRecord::Base
+
+    has_one :payment, as: :source
+    belongs_to :order
+    belongs_to :user
+    belongs_to :payment_method
+
+    scope :unregistered, -> { where(status: 'waiting_registry') }
+
+    # Displays what actions can be done according to payment method
+    #
+    # @author Isabella Santos
+    #
+    # @return [Array]
+    #
+    def actions
+      act = []
+      act << 'capture' if can_capture? payment
+      act << 'void' if can_void? payment
+      act
+    end
+
+    # Save the amount of the billet
+    # if amount is a string, convert to a BigDecimal
+    #
+    # copy of Spree::Payment.amount
+    #
+    def amount=(amount)
+      self[:amount] =
+          case amount
+            when String
+              separator = I18n.t('number.currency.format.separator')
+              number    = amount.delete("^0-9-#{separator}\.").tr(separator, '.')
+              number.to_d if number.present?
+          end || amount
+    end
+
+    # Determines whether can capture the payment
+    # (only can capture when the state is checkout or pending)
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def can_capture?(payment)
+      payment.pending? || payment.checkout?
+    end
+
+    # Determines whether can void the payment
+    # (only can void when the state is different of void, failure or invalid)
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def can_void?(payment)
+      !%w(void failure invalid).include?(payment.state)
+    end
+
+    # Defines the currency of the billet
+    # based in te currency of the order
+    #
+    # copy of Spree::Payment.currency
+    #
+    def currency
+      order.currency
+    end
+
+    # Calculates the due date
+    # according to created at
+    #
+    # @author Isabella Santos
+    #
+    # @return [Date]
+    #
+    def due_date
+      created_at + Spree::BilletConfig.due_date.days
+    end
+
+    # Generate the object from gem brcobranca
+    #
+    # @author Isabella Santos
+    #
+    # @return [Brcobranca::Boleto::Base]
+    #
+    def generate_document
+      config = Spree::BilletConfig
+      doc_user = user.attributes[config.doc_customer_attr] rescue ''
+
+      params = {cedente: config.corporate_name,
+                documento_cedente: config.document,
+                cedente_endereco: config.address,
+                sacado: self.customer_name,
+                sacado_documento: doc_user,
+                sacado_endereco: order.bill_address.full_address,
+                numero_documento: document_number,
+                dias_vencimento: config.due_date,
+                data_documento: Date.parse(created_at.to_s),
+                valor: amount,
+                aceite: config.acceptance,
+                agencia: config.agency,
+                conta_corrente: config.account,
+                convenio: config.agreement,
+                carteira: config.wallet,
+                variacao: config.variation_wallet
+      }
+      (1..6).each { |cont| params["instrucao#{cont}".to_sym] = config["instruction_#{cont}"] }
+      if config.bank == 'sicredi' then
+        params.merge!({posto: config.office_code,
+                       byte_idt: config.byte_idt})
+      end
+
+      document = case config.bank
+                   when 'banco_brasil' then Brcobranca::Boleto::BancoBrasil.new params
+                   when 'bradesco'     then Brcobranca::Boleto::Bradesco.new params
+                   when 'caixa'        then Brcobranca::Boleto::Caixa.new params
+                   when 'santander'    then Brcobranca::Boleto::Santander.new params
+                   when 'itau'         then Brcobranca::Boleto::Itau.new params
+                   when 'sicredi'      then Brcobranca::Boleto::Sicredi.new params
+                   else
+                  raise 'It is necessary set the billet config'
+                 end
+      document
+    end
+
+    # Return the amount converted to Money
+    # according to currency
+    #
+    # copy of Spree::Payment.money
+    #
+    def money
+      Spree::Money.new(amount, { currency: currency })
+    end
+    alias display_amount money
+
+    # Returns the name of the customer according
+    # to bill address of order
+    #
+    # @author Isabella Santos
+    #
+    # @return [String]
+    #
+    def customer_name
+      "#{order.bill_address.firstname} #{order.bill_address.lastname}"
+    rescue
+      ''
+    end
+
+    # Returns if billet is paid
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def paid?
+      status == 'paid'
+    end
+
+    # Returns if billet is pending
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def pending?
+      status == 'pending'
+    end
+
+    # Returns if billet is waiting registry
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def waiting_registry?
+      status == 'waiting_registry'
+    end
+
+    # Return if it is possible generate the document
+    # (when status is waiting registry or pending)
+    #
+    # @author Isabella Santos
+    #
+    # @return [Boolean]
+    #
+    def can_generate_document?
+      %w(waiting_registry pending).include?(status)
+    end
+
+    # Chanege the status to pending
+    #
+    # @author Isabella Santos
+    #
+    def to_pending!
+      self.status = 'pending'
+      self.save
+    end
+
+    def self.generate_shipping
+      return {reason: :there_are_not_any_billets_to_registry, messages: []} if unregistered.empty?
+      config = Spree::BilletConfig
+      params = {empresa_mae: config.corporate_name,
+                agencia: config.agency,
+                conta_corrente: config.account,
+                sequencial_remessa: config.shipping_number}
+      document = case config.bank
+                   when 'banco_brasil'
+                     Brcobranca::Remessa::Cnab240::BancoBrasil.new(params.merge!({convenio: config.agreement,
+                                                                                  carteira: config.wallet,
+                                                                                  documento_cedente: config.document,
+                                                                                  variacao: config.variation_wallet}))
+                   when 'bradesco'
+                     Brcobranca::Remessa::Cnab400::Bradesco.new(params.merge!({digito_conta: config.account_digit,
+                                                                               carteira: config.wallet,
+                                                                               codigo_empresa: config.company_code}))
+                   when 'caixa'
+                     Brcobranca::Remessa::Cnab240::Caixa.new(params.merge!({convenio: config.agreement,
+                                                                            digito_conta: config.account_digit,
+                                                                            documento_cedente: config.document,
+                                                                            versao_aplicativo: config.app_version}))
+                   when 'itau'
+                     Brcobranca::Remessa::Cnab400::Itau.new(params.merge!({carteira: config.wallet,
+                                                                           documento_cedente: config.document,
+                                                                           digito_conta: config.account_digit}))
+                   else
+                     return {reason: :billet_bank_not_implemented, messages: []}
+                 end
+      document.pagamentos = []
+      unregistered.each do |billet|
+        next if billet.user.nil?
+        doc_user = billet.user.attributes[config.doc_customer_attr] rescue ''
+        user_address = billet.order.bill_address
+        payment = Brcobranca::Remessa::Pagamento.new(valor: billet.amount,
+                                                     data_vencimento: billet.due_date,
+                                                     nosso_numero: billet.document_number,
+                                                     documento_sacado: doc_user,
+                                                     nome_sacado: billet.customer_name,
+                                                     endereco_sacado: user_address.address1,
+                                                     bairro_sacado: user_address.address2,
+                                                     cep_sacado: user_address.zipcode,
+                                                     cidade_sacado: user_address.city,
+                                                     uf_sacado: user_address.state.abbr)
+        document.pagamentos << payment
+      end
+      shipping = document.gera_arquivo
+      if shipping.is_a? String
+        config.shipping_number += 1
+        # change the status of billets to pending
+        unregistered.each { |billet| billet.to_pending! }
+      end
+      shipping
+    rescue Brcobranca::RemessaInvalida => invalid
+      {reason: :invalid_billets, messages: invalid.to_s.split(', ')}
+    end
+  end
+end

data/app/models/spree/payment_method/billet.rb

@@ -0,0 +1,83 @@
+module Spree
+  class PaymentMethod::Billet < PaymentMethod
+
+    def payment_source_class
+      Spree::Billet
+    end
+
+    # Purchases the payment
+    # saving the amount, document number (payment ID)
+    # on source object (Spree::Billet)
+    # This method is called when th payment method is set to auto capture
+    # so, this will create the billet with status paid
+    #
+    # @author Isabella Santos
+    #
+    # @return [ActiveMerchant::Billing::Response]
+    #
+    def purchase(amount, source, *args)
+      source.amount = amount.to_d / 100
+      source.document_number = source.payment.id
+      source.status = 'paid'
+
+      source.payment.response_code = source.document_number
+      ret = source.save
+
+      ActiveMerchant::Billing::Response.new(ret, '', {}, authorization: source.document_number)
+    end
+
+    # Authorizes the payment
+    # saving the amount, document number (payment ID)
+    # on source object (Spree::Billet)
+    #
+    # @author Isabella Santos
+    #
+    # @return [ActiveMerchant::Billing::Response]
+    #
+    def authorize(amount, source, *args)
+      source.amount = amount.to_d / 100
+      source.document_number = source.payment.id
+
+      ret = source.save
+
+      ActiveMerchant::Billing::Response.new(ret, '', {}, authorization: source.document_number)
+    end
+
+    # Captures the payment
+    # modifying the status and amount and saving the paid date
+    # of the source (Spree::Billet)
+    #
+    # @author Isabella Santos
+    #
+    # @return [ActiveMerchant::Billing::Response]
+    #
+    def capture(amount, response_code, gateway_options)
+      billet = Spree::Billet.find_by document_number: response_code
+      billet.amount = amount.to_d / 100
+      billet.paid_in = Date.today
+      billet.status = 'paid'
+      billet.save
+
+      ActiveMerchant::Billing::Response.new(true, 'Billet Method: Successfully captured', {}, authorization: response_code)
+    rescue
+      ActiveMerchant::Billing::Response.new(false, 'Billet Method: Failed when try capture', {}, {})
+    end
+
+    # Voids the payment
+    # modifying the status of the source (Spree::Billet)
+    #
+    # @author Isabella Santos
+    #
+    # @return [ActiveMerchant::Billing::Response]
+    #
+    def void(response_code, gateway_options)
+      billet = Spree::Billet.find_by document_number: response_code
+      billet.status = 'void'
+      billet.save
+
+      ActiveMerchant::Billing::Response.new(true, 'Billet Method: Successfully voided', {}, authorization: response_code)
+    rescue
+      ActiveMerchant::Billing::Response.new(false, 'Billet Method: Failed when try void', {}, {})
+    end
+  end
+end

data/app/overrides/spree/admin/shared/_main_menu/add_payment_tab_to_main_menu.html.erb.deface

@@ -0,0 +1,6 @@
+<!-- insert_before "erb[silent]:contains('if can? :admin, Spree::Product')" -->
+<% if can? :admin, Spree::Payment %>
+    <ul class="nav nav-sidebar">
+      <%= main_menu_tree Spree.t(:payments), icon: "usd", sub_menu: "payment", url: "#sidebar-payment" %>
+    </ul>
+<% end %>

data/app/overrides/spree/admin/shared/sub_menu/_configuration/add_billet_settings_tab.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_bottom "[data-hook='admin_configurations_sidebar_menu'], #admin_configurations_sidebar_menu[data-hook]" -->
+<%= configurations_sidebar_menu_item t(:billet_settings), edit_admin_billet_settings_path %>

data/app/overrides/spree/payments/_payment/add_billet_info_to_order_details.html.erb.deface

@@ -0,0 +1,6 @@
+<!-- replace "erb[silent]:contains('else')" -->
+<% elsif source.is_a?(Spree::Billet) %>
+  <label><%= Spree.t(:payment_method_billet) %></label><br />
+  <span><%= "#{Spree.t(:due_date)}: #{source.due_date.strftime(t('date.formats.default'))}" %></span><br />
+  <%= link_to Spree.t(:generate_billet), billet_path(source.id), target: '_blank', class: 'btn btn-sm btn-info' if source.can_generate_document? %>
+<% else %>

data/app/views/spree/admin/billet_settings/edit.html.erb

@@ -0,0 +1,154 @@
+<%= render :partial => 'spree/admin/shared/sub_menu/configuration' %>
+
+<% content_for :page_title do %>
+    <%= Spree.t(:billet_settings) %>
+<% end %>
+
+<%= form_tag admin_billet_settings_path, :method => :put  do |form| %>
+    <div id="billet_preferences" data-hook="billet_preferences">
+      <div class="panel panel-default">
+        <div class="panel-heading">
+          <h1 class="panel-title">
+            <%= Spree.t(:settings) %>
+          </h1>
+        </div>
+        <div class="panel-body">
+          <div class="row">
+            <div class="col-sm-12">
+              <%= label_tag(:corporate_name, Spree.t(:corporate_name) + ': ') + tag(:br) %>
+              <%= text_field_tag :corporate_name, @config.corporate_name, class: 'form-control' %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-4">
+              <%= label_tag(:document, Spree.t(:document) + ': ') + tag(:br) %>
+              <%= text_field_tag :document, @config.document, class: 'form-control' %>
+            </div>
+            <div class="col-sm-8">
+              <%= label_tag(:address, Spree.t(:address) + ': ') + tag(:br) %>
+              <%= text_field_tag :address, @config.address, class: 'form-control' %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-12">
+              <%= check_box_tag :registered, true, @config.registered %>
+              <%= label_tag(:registered) %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-4">
+              <%= label_tag(:shipping_number, Spree.t(:shipping_number) + ': ') + tag(:br) %>
+              <%= text_field_tag :shipping_number, @config.shipping_number, class: 'form-control', disabled: true %>
+            </div>
+            <div class="col-sm-4">
+              <%= label_tag(:clear_shipping_number, ' ') + tag(:br) %>
+              <%= link_to_with_icon 'trash', Spree.t(:clear_shipping_number), admin_clear_shipping_url, class: 'btn btn-warning',
+                                                                                                        id: 'clear_shipping' %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-12">
+              <%= label_tag(:bank, Spree.t(:bank) + ': ') + tag(:br) %>
+              <%= select_tag :bank,
+                             options_for_select(@banks.collect { |item| [Spree.t("bank_#{item}"), item] }, @config.bank),
+                             class: 'select2', include_blank: true %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-4">
+              <%= label_tag(:agency, Spree.t(:agency) + ': ') + tag(:br) %>
+              <%= text_field_tag :agency, @config.agency, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4">
+              <%= label_tag(:account, Spree.t(:account) + ': ') + tag(:br) %>
+              <%= text_field_tag :account, @config.account, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="account_digit_box">
+              <%= label_tag(:account_digit, Spree.t(:account_digit) + ': ') + tag(:br) %>
+              <%= text_field_tag :account_digit, @config.account_digit, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="agreement_box">
+              <%= label_tag(:agreement, Spree.t(:agreement) + ': ') + tag(:br) %>
+              <%= text_field_tag :agreement, @config.agreement, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="wallet_box">
+              <%= label_tag(:wallet, Spree.t(:wallet) + ': ') + tag(:br) %>
+              <%= text_field_tag :wallet, @config.wallet, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="variation_wallet_box">
+              <%= label_tag(:variation_wallet, Spree.t(:variation_wallet) + ': ') + tag(:br) %>
+              <%= text_field_tag :variation_wallet, @config.variation_wallet, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="app_version_box">
+              <%= label_tag(:app_version, Spree.t(:app_version) + ': ') + tag(:br) %>
+              <%= text_field_tag :app_version, @config.app_version, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="company_code_box">
+              <%= label_tag(:company_code, Spree.t(:company_code) + ': ') + tag(:br) %>
+              <%= text_field_tag :company_code, @config.company_code, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="byte_idt_box">
+              <%= label_tag(:byte_idt, Spree.t(:byte_idt) + ': ') + tag(:br) %>
+              <%= text_field_tag :byte_idt, @config.byte_idt, class: 'form-control' %>
+            </div>
+            <div class="col-sm-4" id="office_code_box">
+              <%= label_tag(:office_code, Spree.t(:office_code) + ': ') + tag(:br) %>
+              <%= text_field_tag :office_code, @config.office_code, class: 'form-control' %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-4">
+              <%= label_tag(:due_date, Spree.t(:due_date) + ': ') + tag(:br) %>
+              <%= number_field_tag :due_date, @config.due_date, class: 'form-control' %>
+            </div>
+            <div class="col-sm-8">
+              <%= label_tag(:acceptance, Spree.t(:acceptance) + ': ') + tag(:br) %>
+              <%= radio_button_tag :acceptance, 'S', @config.acceptance == 'S' %>
+              <%= label_tag(:acceptance_s, Spree.t(:yes)) %>
+              <%= radio_button_tag :acceptance, 'N', @config.acceptance == 'N' %>
+              <%= label_tag(:acceptance_n, Spree.t(:no)) %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_1, Spree.t(:instruction_1) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_1, @config.instruction_1, class: 'form-control' %>
+            </div>
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_2, Spree.t(:instruction_2) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_2, @config.instruction_2, class: 'form-control' %>
+            </div>
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_3, Spree.t(:instruction_3) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_3, @config.instruction_3, class: 'form-control' %>
+            </div>
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_4, Spree.t(:instruction_4) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_4, @config.instruction_4, class: 'form-control' %>
+            </div>
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_5, Spree.t(:instruction_5) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_5, @config.instruction_5, class: 'form-control' %>
+            </div>
+            <div class="col-sm-6">
+              <%= label_tag(:instruction_6, Spree.t(:instruction_6) + ': ') + tag(:br) %>
+              <%= text_field_tag :instruction_6, @config.instruction_6, class: 'form-control' %>
+            </div>
+          </div>
+          <div class="row">
+            <div class="col-sm-12">
+              <%= label_tag(:doc_customer_attr, Spree.t(:doc_customer_attr) + ': ') + tag(:br) %>
+              <%= select_tag :doc_customer_attr,
+                             options_for_select(@user_attr.collect { |item| [Spree.t(item), item] }, @config.doc_customer_attr),
+                             class: 'select2', include_blank: true %>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+    <%= render partial: 'spree/admin/shared/edit_resource_links', locals: { collection_url: edit_admin_billet_settings_url } %>
+<% end %>
+
+<script type="text/javascript">
+    new window.BilletSetting();
+</script>