invoicing_payments_processing 1.1.1

data/lib/invoiceitem.rb

@@ -0,0 +1,11 @@
+module BlackStack
+  class InvoiceItem < Sequel::Model(:invoice_item)
+    InvoiceItem.dataset = InvoiceItem.dataset.disable_insert_output
+    many_to_one :invoice, :class=>:'BlackStack::Invoice', :key=>:id_invoice  
+  
+    def plan_descriptor()
+      BlackStack::InvoicingPaymentsProcessing::plan_descriptor(self.item_number)
+    end
+
+  end # class LocalInvoiceItem
+end # module BlackStack

data/lib/invoicing_payments_processing.rb

@@ -0,0 +1,127 @@
+require 'blackstack_commons'
+require 'pampa_workers'
+
+# 
+# 
+# 
+module BlackStack
+  
+  module InvoicingPaymentsProcessing
+    
+    # constants
+    PAYPAL_ORDERS_URL = "https://www.paypal.com"
+    
+    # static attributes
+    @@paypal_business_email = "sardi.leandro.daniel@gmail.com"
+    @@products_descriptor = []
+    @@plans_descriptor = []
+
+    # getters & setters
+    def self.set_paypal_business_email(email)
+      @@paypal_business_email = email
+    end # def self.set_paypal_business_email
+
+    def self.paypal_business_email()
+      @@paypal_business_email
+    end # def self.set_paypal_business_email
+
+    def self.paypal_ipn_listener()
+      "#{BlackStack::Pampa::api_url.to_s}/api1.3/accounting/paypal/notify_new_invoice.json"
+    end
+    
+
+    def self.set_products(h)
+      @@products_descriptor = h
+    end # def self.set_products
+
+    def self.products_descriptor()
+      @@products_descriptor
+    end # def self.products_descriptor
+    
+
+    def self.set_plans(h)
+      @@plans_descriptor = h
+    end # def self.set_plans
+
+    def self.plans_descriptor()
+      @@plans_descriptor
+    end # def self.plans_descriptor
+
+
+    def self.plan_descriptor(item_number)
+      plan = BlackStack::InvoicingPaymentsProcessing::plans_descriptor.select { |h| h[:item_number].to_s == item_number.to_s }.first
+      raise "Plan not found" if plan.nil?
+      plan
+    end
+  
+    def self.product_descriptor(product_code)
+      ret = BlackStack::InvoicingPaymentsProcessing::products_descriptor.select { |h| h[:code] == product_code }.first
+      raise "Product not found" if ret.nil?
+      ret 
+    end
+
+
+    def self.require_db_classes()
+      # You have to load all the Sinatra classes after connect the database.
+      require_relative '../lib/balance.rb'
+      require_relative '../lib/bufferpaypalnotification.rb'
+      require_relative '../lib/customplan.rb'
+      require_relative '../lib/invoice.rb'
+      require_relative '../lib/invoiceitem.rb'
+      require_relative '../lib/movement.rb'
+      require_relative '../lib/paypalsubscription.rb'
+      require_relative '../lib/extend_client_by_invoicing_payments_processing.rb'
+    end
+
+    class BasePlan
+      PAYMENT_PAY_AS_YOU_GO = 'G'
+      PAYMENT_SUBSCRIPTION = 'S'
+
+      CONSUMPTION_BY_UNIT = 0 # el producto se conume credito por credito. Ejemplo: lead records.
+      CONSUMPTION_BY_TIME = 1 # el producto exira al final del periodo de la factura. Ejemplos: Publicidad. Membresía.  
+
+      PRODUCT_WAREHOUSE = 'Warehouse Service'
+      PRODUCT_SOFTWARE = 'Software Service'
+      PRODUCT_AGENCY = 'Agency Service'
+      PRODUCT_EDUCATION = 'Education Service'
+      PRODUCT_OTHER = 'Other Service'
+  
+      #
+      def self.payment_types()
+        [PAYMENT_PAY_AS_YOU_GO, PAYMENT_SUBSCRIPTION]
+      end
+
+      def self.payment_type_description(type)
+        return 'Pay as You Go' if type == PAYMENT_PAY_AS_YOU_GO
+        return 'Subscription' if type == PAYMENT_SUBSCRIPTION
+      end
+
+      #
+      def self.consumption_types()
+        [CONSUMPTION_BY_UNIT, CONSUMPTION_BY_TIME]
+      end
+
+      def self.consumption_type_description(type)
+        return 'Pay as You Go' if type == CONSUMPTION_BY_UNIT
+        return 'Subscription' if type == CONSUMPTION_BY_TIME
+      end
+
+      # 
+      def self.product_types()
+        [PRODUCT_WAREHOUSE, PRODUCT_SOFTWARE, PRODUCT_AGENCY, PRODUCT_EDUCATION, PRODUCT_OTHER]  
+      end
+
+      def self.product_type_icon(s)
+        return "icon-cloud" if s == PRODUCT_WAREHOUSE
+        return "icon-desktop" if s == PRODUCT_SOFTWARE
+        return "icon-coffee" if s == PRODUCT_AGENCY 
+        return "icon-book" if s == PRODUCT_EDUCATION
+        return "icon-help" if s == PRODUCT_OTHER
+      end
+
+
+    end # class BasePlan
+     
+  end # module InvoicingPaymentsProcessing
+  
+end # module BlackStack

data/lib/movement.rb

@@ -0,0 +1,138 @@
+module BlackStack
+  class Movement < Sequel::Model(:movement)
+    BlackStack::Movement.dataset = BlackStack::Movement.dataset.disable_insert_output
+    self.dataset = self.dataset.disable_insert_output
+  
+    many_to_one :invoiceItem, :class=>:'BlackStack::InvoiceItem', :key=>:id_invoice_item
+    many_to_one :client, :class=>:'BlackStack::Client', :key=>:id_client
+  
+    MOVEMENT_TYPE_ADD_PAYMENT = 0
+    MOVEMENT_TYPE_ADD_BONUS = 1
+    MOVEMENT_TYPE_REASSIGN_BALANCE = 2
+    MOVEMENT_TYPE_REFUND_BALANCE = 3
+    MOVEMENT_TYPE_CANCELATION = 4 # liability with the client is reduced due service delivery
+    MOVEMENT_TYPE_EXPIRATION = 5 # liability with the client is reduced due credits expiration
+  
+    def typeName()
+      if (self.type==MOVEMENT_TYPE_ADD_PAYMENT)
+        return "Payment"
+      elsif (self.type==MOVEMENT_TYPE_ADD_BONUS)
+        return "Bonus"
+      elsif (self.type==MOVEMENT_TYPE_REASSIGN_BALANCE)
+        return "Reassignation"
+      elsif (self.type==MOVEMENT_TYPE_REFUND_BALANCE)
+        return "Refund"
+      elsif (self.type==MOVEMENT_TYPE_CANCELATION)
+        return "Service"
+      elsif (self.type==MOVEMENT_TYPE_EXPIRATION)
+        return "Expiration"
+      end
+    end
+  
+    def typeColorName()
+      if (self.type==MOVEMENT_TYPE_ADD_PAYMENT)
+        return "green"
+      elsif (self.type==MOVEMENT_TYPE_ADD_BONUS)
+        return "orange"
+      elsif (self.type==MOVEMENT_TYPE_REASSIGN_BALANCE)
+        return "black"
+      elsif (self.type==MOVEMENT_TYPE_REFUND_BALANCE)
+        return "red"
+      elsif (self.type==MOVEMENT_TYPE_CANCELATION)
+        return "blue"
+      elsif (self.type==MOVEMENT_TYPE_EXPIRATION)
+        return "blue"
+      end
+    end
+    
+    # actualiza el registro con los valores del item de una factura
+    # type may be either MOVEMENT_TYPE_ADD_PAYMENT or MOVEMENT_TYPE_ADD_BONUS, but not other value
+    def parse(item, type=MOVEMENT_TYPE_ADD_PAYMENT, description='n/a')
+      plan = BlackStack::InvoicingPaymentsProcessing.plan_descriptor(item.item_number)
+      prod = BlackStack::InvoicingPaymentsProcessing.product_descriptor(plan[:product_code])
+
+      if (self.id==nil)
+        self.id=guid()
+      end
+      self.id_client = item.invoice.id_client
+      self.id_invoice_item = item.id
+      self.create_time = item.invoice.billing_period_from
+      self.type = type
+      if (type != MOVEMENT_TYPE_ADD_BONUS)
+        self.paypal1_amount = item.amount.to_f
+        self.bonus_amount = 0
+      else
+        self.paypal1_amount = 0
+        self.bonus_amount = item.amount.to_f
+      end      
+      self.amount = 0-item.amount.to_f
+      self.credits = 0-item.units.to_i
+      self.product_code = item.product_code
+      self.profits_amount = 0
+      self.description = description
+      self.expiration_time = DB["SELECT DATEADD(#{prod[:credits_expiration_period].to_s}#{prod[:credits_expiration_period].to_s}, +#{prod[:credits_expiration_units].to_s}, GETDATE()) AS d"].first[:d].to_s    
+      self.save()
+    end
+
+    # Creates a new record in the table movement, as an expiration of the unused credits of this movement.
+    # This movement must be either a payment or a bonus.
+    # This movement must have an expiration time.
+    # The expiraton time of this movement is lower than the current date-time.
+    def expire()
+      m = self
+      p = BlackStack::InvoicingPaymentsProcessing::product_descriptor(m.product_code)
+
+      if m.type != MOVEMENT_TYPE_ADD_PAYMENT && m.type != MOVEMENT_TYPE_ADD_BONUS
+        raise "Movement type mismatch."
+      end
+
+      if m.expiration_time.nil?
+        raise "Expiration time is null."
+      end
+
+      if m.expiration_time >= Time::now()
+        raise "Expiration time is pending."
+      end
+
+      if m.expiration_time <= m.create_time
+        raise "Expiration time is lower then creation time."
+      end
+      
+      # calculo cuantos creditos tiene este cliente
+      x = 0.to_f - BlackStack::Balance.new(m.client.id, p[:code]).credits.to_f
+
+      # calculo el credito adquirido luego de este movimiento que voy a cancelar
+      y = m.client.movements.select { |o| 
+        (
+          o.type == BlackStack::Movement::MOVEMENT_TYPE_ADD_PAYMENT || 
+          o.type == BlackStack::Movement::MOVEMENT_TYPE_ADD_BONUS
+        ) &&
+        o.product_code.upcase == p[:code].upcase && 
+        o.create_time > m.create_time 
+      }.inject(0) { |sum, o| sum.to_f + (0.to_f - o.credits.to_f) }.to_f
+
+      # calculo el # de creditos no usados de este movimiento que ha expirado
+      z = x-y>0 ? x-y : 0 
+
+      # si el monto expirado es positivo, entonces registro
+      # una cancelacion de saldo
+      if z>0
+        amount = ( m.amount.to_f / m.credits.to_f ) * z.to_f              
+        m = BlackStack::Movement.new(
+          :id_client => m.client.id,
+          :create_time => now(),
+          :type => BlackStack::Movement::MOVEMENT_TYPE_EXPIRATION,
+          :description => "Expiration of #{m.id.to_guid}",
+          :paypal1_amount => 0,
+          :bonus_amount => 0,
+          :amount => amount,
+          :credits => z,
+          :profits_amount => -amount,
+          :product_code => p[:code],
+        )
+        m.id = guid()
+        m.save
+      end # z>0
+    end # def expire
+  end # class Movement
+end # module BlackStack

data/lib/paypalsubscription.rb

@@ -0,0 +1,131 @@
+module BlackStack
+  class PayPalSubscription < Sequel::Model(:payPal_subscription)
+    BlackStack::PayPalSubscription.dataset = BlackStack::PayPalSubscription.dataset.disable_insert_output
+    many_to_one :buffer_paypal_notification, :class=>:'BlackStack::BufferPayPalNotification', :key=>:id_buffer_paypal_notification
+    many_to_one :client, :class=>:'BlackStack::Client', :key=>:id_client
+    one_to_many :invoices, :class=>:'BlackStack::Invoice', :key=>:id_paypal_subscription
+    
+    # ----------------------------------------------------------------------------------------- 
+    # Factory
+    # ----------------------------------------------------------------------------------------- 
+    #
+  
+    # retorna true si existe un registro en :payPal_subscription con el mismo valor subscr_id.
+    # sin retorna false.
+    def self.load(params)
+      BlackStack::PayPalSubscription.where(:subscr_id=>params['subscr_id']).first
+    end
+  
+    # crea un nuevo objeto BufferPayPalNotification, y le mapea los atributos en el hash params.
+    # no guarda el objeto en la base de datos.
+    # retorna el objeto creado.
+    def self.create(params)
+        s = BlackStack::PayPalSubscription.new()
+        s.subscr_id = params['subscr_id'].to_s
+        s.last_name = params['last_name'].to_s
+        s.residence_country = params['residence_country'].to_s
+        s.mc_currency = params['mc_currency'].to_s
+        s.item_name = params['item_name'].to_s
+        s.amount1 = params['amount1'].to_s
+        s.business = params['business'].to_s
+        s.amount3 = params['amount3'].to_s
+        s.recurring = params['recurring'].to_s
+        s.verify_sign = params['verify_sign'].to_s
+        s.payer_status = params['payer_status'].to_s
+        s.test_ipn = params['test_ipn'].to_s
+        s.payer_email = params['payer_email'].to_s
+        s.first_name = params['first_name'].to_s
+        s.receiver_email = params['receiver_email'].to_s
+        s.payer_id = params['payer_id'].to_s
+        s.invoice = params['invoice'].to_s
+        s.reattempt = params['reattempt'].to_s
+        s.item_number = params['item_number'].to_s
+        s.subscr_date = params['subscr_date'].to_s
+        s.charset = params['charset'].to_s
+        s.notify_version = params['notify_version'].to_s
+        s.period1 = params['period1'].to_s
+        s.mc_amount1 = params['mc_amount1'].to_s
+        s.period3 = params['period3'].to_s
+        s.mc_amount3 = params['mc_amount3'].to_s
+        s.ipn_track_id = params['ipn_track_id'].to_s
+        s
+    end
+  
+    # retorna un hash descriptor de este objecto
+    def to_hash()
+      ret = {}
+      # campos de uso interno
+      ret['id'] = self.id 
+      ret['create_time'] = self.create_time.datetime_sql_to_api 
+      ret['id_client'] = self.id_client 
+      ret['id_buffer_paypal_notification'] = self.id_buffer_paypal_notification 
+      ret['active'] = self.active 
+      # vinculacion a objetos
+      ret['id_pipeline'] = self.id_pipeline 
+      ret['id_lngroup'] = self.id_lngroup 
+      ret['id_crmlist'] = self.id_crmlist
+      # campos replicados del ipn
+      ret['subscr_id'] = self.subscr_id 
+      ret['last_name'] = self.last_name 
+      ret['residence_country'] = self.residence_country 
+      ret['mc_currency'] = self.mc_currency
+      ret['item_name'] = self.item_name
+      ret['amount1'] = self.amount1
+      ret['business'] = self.business 
+      ret['amount3'] = self.amount3 
+      ret['recurring'] = self.recurring 
+      ret['verify_sign'] = self.verify_sign 
+      ret['payer_status'] = self.payer_status 
+      ret['test_ipn'] = self.test_ipn
+      ret['payer_email'] = self.payer_email 
+      ret['first_name'] = self.first_name 
+      ret['receiver_email'] = self.receiver_email 
+      ret['payer_id'] = self.payer_id
+      ret['invoice'] = self.invoice 
+      ret['reattempt'] = self.reattempt 
+      ret['item_number'] = self.item_number 
+      ret['subscr_date'] = self.subscr_date 
+      ret['charset'] = self.charset
+      ret['notify_version'] = self.notify_version 
+      ret['period1'] = self.period1
+      ret['mc_amount1'] = self.mc_amount1 
+      ret['period3'] = self.period3
+      ret['mc_amount3'] = self.mc_amount3 
+      ret['ipn_track_id'] = self.ipn_track_id 
+      ret
+    end
+  
+    # TODO: deprecated
+    # Retorna el objeto vinculado a esta suscripcion
+    def assignedObject()
+      if (self.item_number =~ /^#{PRODUCT_SSM}\./)
+        return self.pipeline
+      elsif (self.item_number =~ /^#{PRODUCT_FLD}\./)
+        return self.crmlist
+      elsif (self.item_number =~ /^#{PRODUCT_IPJ}\./)
+        return self.lngroup
+      else # unknown
+        return nil
+      end
+    end
+    
+    # retorna un array con facturas de esta suscripcion
+    def invoices()
+      a = []
+      if self.subscr_id.to_s.size > 0
+        DB[
+        "SELECT DISTINCT i.id " +
+        "FROM invoice i WITH (NOLOCK) " + 
+        "JOIN buffer_paypal_notification b WITH (NOLOCK) ON (b.id=i.id_buffer_paypal_notification AND b.subscr_id='#{self.subscr_id.to_s}') "
+        ].all { |row|
+          a << BlackStack::Invoice.where(:id=>row[:id]).first
+          # release resources 
+          DB.disconnect
+          GC.start
+        }      
+      end
+      a
+    end # def invoices
+  
+  end # class PayPalSubscription
+end # module BlackStack

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: invoicing_payments_processing
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.28.0
+- !ruby/object:Gem::Dependency
+  name: pampa_workers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: 'THIS GEM IS STILL IN DEVELOPMENT STAGE. Find documentation here: https://github.com/leandrosardi/invoicing_payments_processing.'
+email: leandro.sardi@expandedventure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/balance.rb
+- lib/bufferpaypalnotification.rb
+- lib/customplan.rb
+- lib/extend_client_by_invoicing_payments_processing.rb
+- lib/invoice.rb
+- lib/invoiceitem.rb
+- lib/invoicing_payments_processing.rb
+- lib/movement.rb
+- lib/paypalsubscription.rb
+homepage: https://rubygems.org/gems/invoicing_payments_processing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: THIS GEM IS STILL IN DEVELOPMENT STAGE. Invoicing and Payments Processing
+  gem (a.k.a. I+2P) is a Ruby gem to setup amazing offers in your website, track them,
+  and also process payments automatically using PayPal.
+test_files: []