erp_txns_and_accts 4.0.0 → 4.2.0

data/app/controllers/api/v1/financial_txns_controller.rb

@@ -0,0 +1,53 @@
+module Api
+  module V1
+    class FinancialTxnsController < BaseController
+
+      def index
+        sort = nil
+        dir = nil
+        limit = nil
+        start = nil
+
+        unless params[:sort].blank?
+          sort_hash = params[:sort].blank? ? {} : Hash.symbolize_keys(JSON.parse(params[:sort]).first)
+          sort = sort_hash[:property] || 'description'
+          dir = sort_hash[:direction] || 'ASC'
+          limit = params[:limit] || 25
+          start = params[:start] || 0
+        end
+
+        query_filter = params[:query_filter].blank? ? {} : JSON.parse(params[:query_filter]).symbolize_keys
+
+        # hook method to apply any scopes passed via parameters to this api
+        financial_txns = FinancialTxn.apply_filters(query_filter)
+
+        # scope by dba_organizations if there are no parties passed as filters
+        unless query_filter[:parties]
+          dba_organizations = [current_user.party.dba_organization]
+          dba_organizations = dba_organizations.concat(current_user.party.dba_organization.child_dba_organizations)
+          financial_txns = financial_txns.scope_by_dba_organization(dba_organizations)
+        end
+
+        if sort and dir
+          financial_txns = financial_txns.order("#{sort} #{dir}")
+        end
+
+        total_count = financial_txns.count
+
+        if start and limit
+          financial_txns = financial_txns.offset(start).limit(limit)
+        end
+
+        render :json => {success: true, total_count: total_count, financial_txns: financial_txns.collect(&:to_data_hash)}
+      end
+
+      def show
+        financial_txn = FinancialTxn.find(params[:id])
+
+        render :json => {financial_txn: financial_txn.to_data_hash}
+      end
+
+
+    end # BizTxnEvents
+  end # V1
+end # Api

data/app/models/biz_txn_acct_pty_rtype.rb

@@ -2,6 +2,7 @@ class BizTxnAcctPtyRtype < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 
   acts_as_nested_set
+  include ErpTechSvcs::Utils::DefaultNestedSetMethods
   acts_as_erp_type
 
   has_many :biz_txn_acct_party_roles

data/app/models/biz_txn_acct_root.rb

@@ -1,14 +1,134 @@
+# create_table :biz_txn_acct_roots do |t|
+#   t.string 	 :description
+#   t.string   :internal_identifier
+#   t.integer  :status
+#   t.integer  :biz_txn_acct_id
+#   t.string   :biz_txn_acct_type
+#   t.string 	 :external_identifier
+#   t.string 	 :external_id_source
+#   t.string   :type
+#
+#   t.integer  :parent_id
+#   t.integer  :lft
+#   t.integer  :rgt
+#
+#   t.references :biz_txn_acct_type
+#   t.timestamps
+# end
+#
+# add_index :biz_txn_acct_roots, [:biz_txn_acct_id, :biz_txn_acct_type], :name => "btai_2"
+# add_index :biz_txn_acct_roots, :biz_txn_acct_type_id, :name => "btai_3"
+# add_index :biz_txn_acct_roots, :parent_id
+# add_index :biz_txn_acct_roots, :lft
+# add_index :biz_txn_acct_roots, :rgt
+
 class BizTxnAcctRoot < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 
+  acts_as_nested_set
+  include ErpTechSvcs::Utils::DefaultNestedSetMethods
+
+  has_tracked_status
+  tracks_created_by_updated_by
+
   belongs_to :biz_txn_acct, :polymorphic => true
-  belongs_to :txn_account_type, :class_name => 'BizTxnAcctType', :foreign_key => 'biz_txn_acct_type_id'
-  has_many   :biz_txn_events, :dependent => :destroy
-  has_many   :biz_txn_acct_party_roles, :dependent => :destroy
+  belongs_to :biz_txn_acct_type
+  has_many :biz_txn_events, :dependent => :destroy
+  has_many :biz_txn_acct_party_roles, :dependent => :destroy
 
   alias :account :biz_txn_acct
   alias :txn_events :biz_txn_events
   alias :txns :biz_txn_events
+  alias :txn_account_type :biz_txn_acct_type
+
+  class << self
+    # Filter records
+    #
+    # @param filters [Hash] a hash of filters to be applied,
+    # @param statement [ActiveRecord::Relation] the query being built
+    # @return [ActiveRecord::Relation] the query being built
+    def apply_filters(filters, statement=nil)
+      unless statement
+        statement = self
+      end
+
+      # filter by parent
+      if filters[:parent]
+        if filters[:parent].is_integer?
+          statement = statement.where(biz_txn_acct_roots: {parent_id: filters[:parent]})
+        else
+          statement = statement.where(biz_txn_acct_roots: {parent_id: BizTxnAcctRoot.iid(filters[:parent])})
+        end
+      end
+
+      # filter by query which will filter on description
+      if filters[:query]
+        statement = statement.where('description like ?', "%#{filters[:query].strip}%")
+      end
+
+      # filter by BizTxnAcctType
+      unless filters[:biz_txn_acct_type_iids].blank?
+        statement = statement.joins(:biz_txn_acct_type).where(biz_txn_acct_type: {internal_identifier: filters[:biz_txn_acct_type_iids]})
+      end
+
+      # filter by Status
+      unless filters[:status].blank?
+        statement = statement.with_current_status(filters[:status].split(','))
+      end
+
+      unless filters[:parties].blank?
+        data = JSON.parse(filters[:parties])
+
+        statement = statement.scope_by_party(data['party_ids'].split(','), {role_types: data['role_types']})
+      end
+
+      statement
+    end
+
+    # scope by dba organization
+    #
+    # @param dba_organization [Party] dba organization to scope by
+    #
+    # @return [ActiveRecord::Relation]
+    def scope_by_dba_organization(dba_organization)
+      scope_by_party(dba_organization, {role_types: 'dba_org'})
+    end
+
+    alias scope_by_dba scope_by_dba_organization
+
+    # scope by party
+    #
+    # @param party [Integer | Party | Array] either a id of Party record, a Party record, an array of Party records
+    # or an array of Party ids
+    # @param options [Hash] options to apply to this scope
+    # @option options [String | Array] :role_types BizTxnAcctPtyRtype internal identifiers to include in the scope,
+    # comma separated or an Array
+    #
+    # @return [ActiveRecord::Relation]
+    def scope_by_party(party, options={})
+      statement = joins(:biz_txn_acct_party_roles)
+                      .where(biz_txn_acct_party_roles: {party_id: party}).uniq
+
+      if options[:role_types]
+        role_types = options[:role_types]
+        unless role_types.is_a? Array
+          role_types = role_types.split(',')
+        end
+
+        statement = statement.joins(biz_txn_acct_party_roles: :biz_txn_acct_pty_rtype)
+                        .where(biz_txn_acct_pty_rtypes: {internal_identifier: role_types})
+      end
+
+      statement
+    end
+
+    # Look up account by internal identifier
+    #
+    # @param internal_identifier [String] Internal Identifier to look up by
+    def iid(internal_identifier)
+      where('internal_identifier = ?', internal_identifier).first
+    end
+  end
 
   def to_label
     "#{description}"
@@ -32,10 +152,14 @@ class BizTxnAcctRoot < ActiveRecord::Base
   def find_parties_by_role(biz_txn_acct_pty_rtype)
     biz_txn_acct_pty_rtype = BizTxnAcctPtyRtype.iid(biz_txn_acct_pty_rtype) if biz_txn_acct_pty_rtype.is_a? String
     raise "BizTxnAcctPtyRtype #{biz_txn_acct_pty_rtype.to_s} does not exist" if biz_txn_acct_pty_rtype.nil?
-    
+
     Party.joins('inner join biz_txn_acct_party_roles on biz_txn_acct_party_roles.party_id = parties.id')
-         .where('biz_txn_acct_pty_rtype_id = ?', biz_txn_acct_pty_rtype.id)
-         .where('biz_txn_acct_root_id = ?', self.id)
+        .where('biz_txn_acct_pty_rtype_id = ?', biz_txn_acct_pty_rtype.id)
+        .where('biz_txn_acct_root_id = ?', self.id)
+  end
+
+  def to_data_hash
+    to_hash(only: [:id, :description, :internal_identifier])
   end
 
 end

data/app/models/biz_txn_acct_type.rb

@@ -3,4 +3,6 @@ class BizTxnAcctType < ActiveRecord::Base
 
   acts_as_nested_set
   include ErpTechSvcs::Utils::DefaultNestedSetMethods
+
+  acts_as_erp_type
 end

data/app/models/biz_txn_event.rb

@@ -1,65 +1,245 @@
+#### Table Definition ###########################
+#  create_table :biz_txn_events do |t|
+#  	t.column  :description,  			    :string
+#  	t.column	:biz_txn_acct_root_id, 	:integer
+#  	t.column	:biz_txn_type_id,       :integer
+#  	t.column 	:entered_date,          :datetime
+#  	t.column 	:post_date,             :datetime
+#  	t.column  :biz_txn_record_id,    	:integer
+#  	t.column  :biz_txn_record_type,  	:string
+#  	t.column 	:external_identifier, 	:string
+#  	t.column 	:external_id_source, 	  :string
+#  	t.timestamps
+#  end
+#
+#  add_index :biz_txn_events, :biz_txn_acct_root_id
+#  add_index :biz_txn_events, :biz_txn_type_id
+#  add_index :biz_txn_events, [:biz_txn_record_id, :biz_txn_record_type], :name => "btai_1"
+#################################################
+
 class BizTxnEvent < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 
+  has_tracked_status
+  tracks_created_by_updated_by
+
   belongs_to :biz_txn_acct_root
-  belongs_to :biz_txn_record, :polymorphic => true 
-  has_many :biz_txn_party_roles, :dependent => :destroy 
+  belongs_to :biz_txn_record, :polymorphic => true
+  has_many :biz_txn_party_roles, :dependent => :destroy
   has_many :biz_txn_event_descs, :dependent => :destroy
   has_many :base_txn_contexts, :dependent => :destroy
   has_many :biz_txn_agreement_roles
   has_many :agreements, :through => :biz_txn_agreement_roles
-  	
+
+  before_destroy :destroy_biz_txn_relationships
+
   #wrapper for...
   #belongs_to :biz_txn_type
   belongs_to_erp_type :biz_txn_type
-	#syntactic sugar
-	alias :txn_type :biz_txn_type
-	alias :txn_type= :biz_txn_type=
-	alias :txn :biz_txn_record
-	alias :txn= :biz_txn_record=
-	alias :account :biz_txn_acct_root
-	alias :account= :biz_txn_acct_root=
-	alias :descriptions :biz_txn_event_descs
-
-  # serialize ExtJs attributes
-  is_json :custom_fields
-
-  
-	#helps when looping through transactions comparing types
-	def txn_type_iid
-		biz_txn_type.internal_identifier if biz_txn_type
-	end
- 
-	def account_root
-		biz_txn_acct_root
-	end
-	
-	def amount
-  	if biz_txn_record.respond_to? :amount
-  		biz_txn_record.amount
-  	else
-  		nil
-  	end   		
-	end 
-  	
-	def amount_string
-		if biz_txn_record.respond_to? :amount_string
-			biz_txn_record.amount_string
-		else
-			"n/a"
-		end 
-	end
-	
-	def create_dependent_txns
-	  #Template Method
-	end
-
-	def to_label
+
+  #syntactic sugar
+  alias :txn_type :biz_txn_type
+  alias :txn_type= :biz_txn_type=
+  alias :txn :biz_txn_record
+  alias :txn= :biz_txn_record=
+  alias :account :biz_txn_acct_root
+  alias :account= :biz_txn_acct_root=
+  alias :descriptions :biz_txn_event_descs
+
+  class << self
+    # Filter records
+    #
+    # @param filters [Hash] a hash of filters to be applied,
+    # @param statement [ActiveRecord::Relation] the query being built
+    # @return [ActiveRecord::Relation] the query being built
+    def apply_filters(filters, statement=nil)
+      unless statement
+        statement = self
+      end
+
+      biz_txn_event_tbl = BizTxnEvent.arel_table
+
+      # filter by query which will filter on description
+      if filters[:query]
+        statement = statement.where('description like ?', "%#{filters[:query].strip}%")
+      end
+
+      # filter by WorkEffortType
+      unless filters[:biz_txn_type_iids].blank?
+        statement = statement.where(biz_txn_type_id: BizTxnType.where(internal_identifier: filters[:biz_txn_type_iids]))
+      end
+
+      # filter by Status
+      unless filters[:status].blank?
+        statement = statement.with_current_status(filters[:status].split(','))
+      end
+
+      # filter by start_at
+      unless filters[:start_date].blank?
+        statement = statement.where(biz_txn_event_tbl[:entered_date].gteq(Time.parse(filters[:start_date])))
+      end
+
+      # filter by end_at
+      unless filters[:end_date].blank?
+        statement = statement.where(biz_txn_event_tbl[:entered_date].lteq(Time.parse(filters[:end_date])))
+      end
+
+      unless filters[:parties].blank?
+        data = JSON.parse(filters[:parties])
+
+        statement = statement.scope_by_party(data['party_ids'].split(','), {role_types: data['role_types']})
+      end
+
+      statement
+    end
+
+    #
+    # scoping helpers
+    #
+
+    # scope by dba organization
+    #
+    # @param dba_organization [Party] dba organization to scope by
+    #
+    # @return [ActiveRecord::Relation]
+    def scope_by_dba_organization(dba_organization)
+      scope_by_party(dba_organization, {role_types: 'dba_org'})
+    end
+
+    alias scope_by_dba scope_by_dba_organization
+
+    # scope by party
+    #
+    # @param party [Integer | Party | Array] either a id of Party record, a Party record, an array of Party records
+    # or an array of Party ids
+    # @param options [Hash] options to apply to this scope
+    # @option options [String | Array] :role_types BizTxnPartyRoleType internal identifiers to include in the scope,
+    # comma separated or an Array
+    #
+    # @return [ActiveRecord::Relation]
+    def scope_by_party(party, options={})
+      statement = joins("inner join biz_txn_party_roles on biz_txn_party_roles.biz_txn_event_id = biz_txn_events.id")
+                      .where("biz_txn_party_roles.party_id" => party).uniq
+
+      if options[:role_types]
+        role_types = options[:role_types]
+        unless role_types.is_a? Array
+          role_types = role_types.split(',')
+        end
+
+        statement = statement.joins("inner join biz_txn_party_role_types
+                                     on biz_txn_party_role_types.id = biz_txn_party_roles.biz_txn_party_role_type_id")
+                        .where(biz_txn_party_role_types: {internal_identifier: role_types})
+      end
+
+      statement
+    end
+  end
+
+  # Get the dba_organization related to this BizTxnEvent
+  #
+  # @return [Party] returns a Party if the dba organization was found
+  def dba_organization
+    dba_org_role_type = BizTxnPartyRoleType.find_or_create('dba_org', 'DBA Organization')
+
+    biz_txn_party_role = biz_txn_party_roles.where('biz_txn_party_roles.biz_txn_party_role_type_id' => dba_org_role_type).first
+
+    if biz_txn_party_role
+      biz_txn_party_role.party
+    end
+  end
+
+  alias dba_org dba_organization
+
+  def destroy_biz_txn_relationships
+    BizTxnRelationship.where("txn_event_id_from = ? or txn_event_id_to = ?", self.id, self.id).destroy_all
+  end
+
+  # helps when looping through transactions comparing types
+  #
+  def txn_type_iid
+    biz_txn_type.internal_identifier if biz_txn_type
+  end
+
+  # get biz_txn_acct_root
+  #
+  # @return [BizTxnAcctRoot]
+  def account_root
+    biz_txn_acct_root
+  end
+
+  # get the amount of this txn if it responds to amount
+  #
+  # @return [BigDecimal | nil]
+  def amount
+    if biz_txn_record.respond_to? :amount
+      biz_txn_record.amount
+    else
+      nil
+    end
+  end
+
+  # get the amount of this txn as a string if it responds to amount_string
+  #
+  # @return [String | nil]
+  def amount_string
+    if biz_txn_record.respond_to? :amount_string
+      biz_txn_record.amount_string
+    else
+      "n/a"
+    end
+  end
+
+  # gets the first party related to this BizTxnEvent with the given BizTxnPartyRoleType
+  #
+  # @param role_type [BizTxnPartyRoleType | String] BizTxnPartyRoleType or internal identifier of BizTxnPartyRoleType
+  # @return [Party | nil]
+  def find_party_by_role_type(role_type)
+    role_type = role_type.is_a?(String) ? BizTxnPartyRoleType.iid(role_type) : role_type
+
+    biz_txn_party_role = biz_txn_party_roles.where(:biz_txn_party_role_type_id => role_type.id).first
+
+    if biz_txn_party_role
+      biz_txn_party_role.party
+    end
+  end
+
+  # returns description of this BizTxnEvent
+  #
+  # @return [String]
+  def to_label
     "#{description}"
-	end
+  end
 
-	def to_s
+  # returns description of this BizTxnEvent
+  #
+  # @return [String]
+  def to_s
     "#{description}"
-	end
+  end
+
+  # converts this record a hash data representation
+  #
+  # @return [Hash]
+  def to_data_hash
+    data = to_hash(only: [:id,
+                          :description,
+                          :entered_date,
+                          :post_date,
+                          :external_identifier,
+                          :external_id_source,
+                          :created_at,
+                          :updated_at])
+
+    data[:status] = self.try(:current_status_application).try(:to_data_hash)
+
+    data
+  end
+
+  # template method to create dependent BizTxnEvents
+  #
+  def create_dependent_txns
+    #Template Method
+  end
 
 end