Feature/add method handling expansion child objects

app/controllers/api/api_controller.rb

@@ -6,6 +6,7 @@ class Api::ApiController < ActionController::Base # rubocop:disable Rails/Applic
 	# We disable Rails/ApplicationController bec
 	include Controllers::Locale
 	include Controllers::Nonprofit::Authorization
+	include Controllers::Api::JbuilderExpansions
 
 	rescue_from ActiveRecord::RecordInvalid, with: :record_invalid_rescue
 	rescue_from AuthenticationError, with: :unauthorized_rescue

app/controllers/api/transactions_controller.rb

@@ -12,12 +12,14 @@ class Api::TransactionsController < Api::ApiController
 	# Gets the nonprofits supporters
 	# If not logged in, causes a 401 error
 	def index
+		set_expansions('supporter', 'subtransaction.payments', 'transaction_assignments', 'payments')
 		@transactions = current_nonprofit.transactions.order('created DESC').page(params[:page]).per(params[:per])
 	end
 
 	# Gets the a single nonprofit supporter
 	# If not logged in, causes a 401 error
 	def show
+		set_expansions('supporter', 'subtransaction.payments', 'transaction_assignments', 'payments')
 		@transaction = current_transaction
 	end
 

app/controllers/concerns/controllers/api/jbuilder_expansions.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+module Controllers::Api::JbuilderExpansions
+	extend ActiveSupport::Concern
+	included do
+		@__expand = Controllers::Api::JbuilderExpansions::ExpansionRequest.new
+
+		def set_expansions(*expansions)
+			@__expand = Controllers::Api::JbuilderExpansions.set_expansions(*expansions)
+		end
+
+		def request_expansions(*expansions)
+			Controllers::Api::JbuilderExpansions.set_expansions(*expansions)
+		end
+
+		def handle_expansion(attribute, object, opts = {})
+			opts = opts.deep_symbolize_keys
+			opts[:__expand] ||= __expand
+			ExpansionRequestProcessor.handle_expansion(attribute, object, opts)
+		end
+
+		def handle_array_expansion(attribute, object, opts = {}, &block)
+			opts[:__expand] ||= __expand
+			ExpansionRequestProcessor.handle_array_expansion(attribute, object, opts, &block)
+		end
+
+		def handle_item_expansion(object, opts = {})
+			opts[:__expand] ||= __expand
+			ExpansionRequestProcessor.handle_item_expansion(object, opts)
+		end
+
+		helper_method :handle_expansion, :handle_array_expansion, :handle_item_expansion, :request_expansions
+	end
+
+	def self.set_expansions(*expansions)
+		request = ExpansionRequest.new
+		expansions = expansions.flatten
+		if expansions.count == 1
+			case expansions.first
+			when String
+				request = ExpansionRequest.new(*expansions)
+			when ExpansionRequest
+				request = expansions.first
+			end
+		elsif expansions.any?
+			request = ExpansionRequest.new(*expansions)
+		end
+
+		request
+	end
+
+	class ExpansionRequestProcessor
+		attr_reader :attribute, :object
+
+		def initialize(attribute, object, opts)
+			@attribute = attribute
+			@object = object
+			@opts = opts.deep_symbolize_keys
+		end
+
+		def json
+			@opts[:json]
+		end
+
+		def exp_request
+			@opts[:__expand]
+		end
+
+		def as
+			@opts[:as] || attribute
+		end
+
+		def item_as
+			@opts[:item_as] || attribute
+		end
+
+		def handle_expansion
+			if object.nil?
+				json.set! attribute, nil
+			elsif exp_request.expand? attribute
+				json.set! attribute do
+					json.partial! object, as: as, __expand: exp_request[attribute]
+				end
+			else
+				json.set! attribute, object&.id
+			end
+		end
+
+		def handle_array_expansion
+			json.set! attribute do
+				if exp_request.expand? attribute
+					object.each do |item|
+						json.child! do
+							yield(item, { json: json, __expand: exp_request[attribute], as: item_as })
+						end
+					end
+				else
+					json.array! object.map(&:id)
+				end
+			end
+		end
+
+		def handle_item_expansion
+			json.partial! object, as: as, __expand: exp_request
+		end
+
+		def self.handle_expansion(attribute, object, opts)
+			ExpansionRequestProcessor.new(attribute, object, opts).handle_expansion
+		end
+
+		def self.handle_array_expansion(attribute, object, opts, &block)
+			ExpansionRequestProcessor.new(attribute, object, opts).handle_array_expansion(&block)
+		end
+
+		def self.handle_item_expansion(object, opts)
+			opts = opts.deep_symbolize_keys
+			ExpansionRequestProcessor.new(nil, object, opts).handle_item_expansion
+		end
+	end
+
+	class ExpansionRequest
+		attr_accessor :path_tree
+
+		def initialize(*paths)
+			@path_tree = Node.new
+			parse_paths(paths)
+		end
+
+		def [](path)
+			if @path_tree.leaf?
+				ExpansionRequest.new
+			else
+				ExpansionRequest.create_from(@path_tree[path] || Node.new)
+
+			end
+		end
+
+		def expand?(path)
+			@path_tree.has_key?(path)
+		end
+
+		class Node < ActiveSupport::HashWithIndifferentAccess
+			def leaf?
+				none?
+			end
+		end
+
+		private
+
+		def parse_paths(paths = [])
+			paths.each do |path|
+				working_tree = @path_tree
+				path.split('.').each do |path_part|
+					working_tree[path_part] = Node.new unless working_tree[path_part]
+					working_tree = working_tree[path_part]
+				end
+			end
+		end
+
+		def self.create_from(tree)
+			er = ExpansionRequest.new
+			er.path_tree = tree
+			er
+		end
+	end
+end

app/models/modern_donation.rb

@@ -56,4 +56,8 @@ def publish_updated
 		Houdini.event_publisher.announce(:donation_updated, to_event('donation.updated', :nonprofit, :supporter, :trx).attributes!)
 		Houdini.event_publisher.announce(:trx_assignment_updated, to_event('trx_assignment.updated', :nonprofit, :supporter, :trx).attributes!)
 	end
+
+		def amount_as_money
+			Amount.new(amount||0, nonprofit.currency)
+		end
 end

app/views/api/modern_donations/_modern_donation.json.jbuilder

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.object 'donation'
+
+json.(assignable, :designation)
+
+json.amount do
+	json.partial! '/api/common/amount', amount: assignable.amount_as_money
+end

app/views/api/modern_donations/object_events/_base.json.jbuilder

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.partial! 'api_new/transaction_assignments/transaction_assignment',
+														transaction_assignment: event_entity.transaction_assignment,
+														__expand: request_expansions(
+															'transaction',
+															'transaction.transaction_assignments',
+															'transaction.subtransaction.payments'
+														)

app/views/api/object_events/_object_event.json.jbuilder

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.id object_event.houid
+json.created object_event.created.to_i
+json.object 'object_event'
+json.type object_event.event_type
+json.data do
+	json.object do
+		json.partial! partial_path, event_entity: object_event.event_entity
+	end
+end

app/views/api/object_events/generate.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+json.partial! @object_event, as: :object_event, object_as: @object_as, partial_path: @partial_path

app/views/api/object_events/index.json.jbuilder

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+json.data do
+	json.array! @object_events.map(&:object_json)
+end
+
+json.current_page @object_events.current_page
+json.first_page @object_events.first_page?
+json.last_page @object_events.last_page?
+json.requested_size @object_events.limit_value
+json.total_count @object_events.total_count

app/views/api/offline_transaction_charges/object_events/_base.json.jbuilder

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.partial! 'api_new/subtransaction_payments/subtransaction_payment',
+														subtransaction_payment: event_entity.subtransaction_payment,
+														__expand: request_expansions(
+															'subtransaction',
+															'subtransaction.transaction',
+															'subtransaction.transaction.transaction_assignments'
+														)

app/views/api/simple_objects/_simple_object.json.jbuilder

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.id object.houid
+
+json.object 'simple_object'
+
+handle_expansion(:parent, object.parent, { json: json, as: :object, __expand: __expand })
+
+handle_expansion(:nonprofit, object.nonprofit, { json: json, __expand: __expand })
+
+handle_array_expansion(:friends, object.friends, { json: json, item_as: :object, __expand: __expand }) do |friend, opts|
+	handle_item_expansion(friend, opts)
+end

app/views/api/simple_objects/object_events/_base.json.jbuilder

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.partial! event_entity, as: :object, __expand: request_expansions('parent')

app/views/api/simple_objects/show.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+json.partial! @simple_object, as: :object, __expand: @__expand

app/views/api/stripe_transaction_charges/_stripe_transaction_charge.json.jbuilder

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.object 'stripe_transaction_charge'
+
+json.net_amount do
+	json.partial! '/api_new/common/amount', amount: paymentable.net_amount_as_money
+end
+
+json.gross_amount do
+	json.partial! '/api_new/common/amount', amount: paymentable.gross_amount_as_money
+end
+
+json.fee_total do
+	json.partial! '/api_new/common/amount', amount: paymentable.fee_total_as_money
+end

app/views/api/stripe_transaction_charges/object_events/_base.json.jbuilder

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.partial! 'api_new/subtransaction_payments/subtransaction_payment',
+														subtransaction_payment: event_entity.subtransaction_payment,
+														__expand: request_expansions(
+															'subtransaction.payments',
+															'subtransaction.transaction.transaction_assignments'
+														)

app/views/api/subtransactions/_subtransaction.json.jbuilder

@@ -2,17 +2,16 @@
 
 # License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
 # Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
-json.(subtransaction.subtransactable, :id)
 
 json.type 'subtransaction'
 json.supporter subtransaction.supporter.id
 json.nonprofit subtransaction.nonprofit.id
 json.transaction subtransaction.trx.id
 
-json.partial! subtransaction.subtransactable, as: :subtransactable
-
 json.payments subtransaction.payments do |py|
 	json.partial! py, as: :subtransaction_payment
 end
 
 json.url api_nonprofit_transaction_subtransaction_url(subtransaction.nonprofit, subtransaction.trx)
+
+json.partial! subtransaction.subtransactable, as: :subtransactable, __expand: __expand

app/views/api/transaction_assignments/_transaction_assignment.json.jbuilder

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+json.type 'trx_assignment'
+
+json.id transaction_assignment.id
+
+handle_expansion(:supporter, transaction_assignment.supporter, { json: json, __expand: __expand })
+handle_expansion(:nonprofit, transaction_assignment.nonprofit, { json: json, __expand: __expand })
+handle_expansion(:transaction, transaction_assignment.trx, { json: json, __expand: __expand })
+
+json.partial! transaction_assignment.assignable, as: :assignable, __expand: __expand

app/views/api/transactions/_transaction.json.jbuilder

@@ -8,18 +8,21 @@ json.object 'transaction'
 
 json.created transaction.created.to_i
 
-json.supporter transaction.supporter.id
+handle_expansion(:supporter, transaction.supporter, { json: json, __expand: __expand })
+
+handle_expansion(:nonprofit, transaction.nonprofit, { json: json, __expand: __expand })
 
 json.nonprofit transaction.nonprofit.id
 
 json.amount do
 	json.partial! '/api/common/amount', amount: transaction.amount_as_money
 end
 
-json.subtransaction transaction&.subtransaction&.to_id
+handle_expansion(:subtransaction, transaction.subtransaction, { json: json, __expand: __expand })
 
-json.transaction_assignments transaction.transaction_assignments do |tra|
-	json.merge! tra.to_id.attributes!
+handle_array_expansion(:transaction_assignments, transaction.transaction_assignments,
+																							{ json: json, __expand: __expand, item_as: :transaction_assignment }) do |tra, opts|
+	handle_item_expansion(tra, opts)
 end
 
 json.payments transaction.payments do |subt_p|