card_request_reports.rb

[geekelo]

FILE

require 'prawn'
require 'prawn/table'

ActiveAdmin.register Card::Request, as: 'CardRequestReport' do
  menu parent: 'Reports', label: 'Card Request Reports'

  config.filters = false
  config.batch_actions = false

  index title: "Card Request Reports by Date Range" do
    panel "Filter Card Request Reports" do
      render 'admin/card_requests/transactions_by_date_form'
    end
    panel "Report Downloads" do
      div do
        link_to "Download Detailed CSV", admin_card_request_reports_path(format: :csv), method: :get
        para "The CSV file contains detailed data for each card request record for the range selected."
        br
        link_to "Download Summary PDF", admin_card_request_reports_path(format: :pdf), method: :get
        para "The PDF file provides a summary overview of the card request for the range selected."
      end
    end
  end

  controller do
    before_action :set_date_range, only: [:index]

    def set_date_range
      @start_date = params.dig(:report, :start_date).present? ? Date.parse(params[:report][:start_date]) : Time.zone.today
      @end_date = params.dig(:report, :end_date).present? ? Date.parse(params[:report][:end_date]) : Time.zone.today
    rescue ArgumentError
      @start_date = Time.zone.today
      @end_date = Time.zone.today
    end

    def index
      @transactions_by_date_range = Card::Request.between_dates(@start_date, @end_date)
      if params.dig(:report, :status).present?
        @transactions_by_date_range = @transactions_by_date_range.where(status: params[:report][:status])
      end

      respond_to do |format|
        format.html
        format.csv { send_data generate_csv(@transactions_by_date_range), filename: "card_request_report.csv" }
        format.pdf { send_data generate_pdf(@transactions_by_date_range), filename: "card_request_summary_report.pdf", type: 'application/pdf' }
      end
    end

    private

    def generate_csv(transactions)
      CSV.generate(headers: true) do |csv|
        csv << ["User ID", "External Id", "Status", "Name", "Email", "Card Type", "Total Amount", "Provider Amount", "Bananacrystal Amount"]
        transactions.each do |cr|
          csv << [
            cr.user_id,
            cr.external_id,
            cr.status,
            cr.user.name,
            cr.user.email,
            cr.card_type,
            cr.total_fee,
            cr.total_provider_fee,
            cr.total_bananacrystal_fee
          ]
        end
      end
    end

    def generate_pdf(transactions)
      Prawn::Document.new do |pdf|
        pdf.text "Card Request Report Summary", size: 20, style: :bold
        pdf.move_down 10
        pdf.text "Date Range: #{@start_date.strftime('%Y-%m-%d')} to #{@end_date.strftime('%Y-%m-%d')}"
        pdf.move_down 10

        data = [
          ["Metric", "Count"],
          ["Number of Denied Card Requests", transactions.declined.between_dates(@start_date, @end_date).count],
          ["Number of Pending Card Requests", transactions.pending.between_dates(@start_date, @end_date).count],
          ["Number of Approved Card Requests", transactions.completed.between_dates(@start_date, @end_date).count],
          ["Total Card Requests", transactions.count]
        ]

        pdf.table(data, header: true) do
          row(0).font_style = :bold
          columns(0..1).align = :center
          self.header = true
          self.column_widths = [200, 200]
          self.row_colors = ["DDDDDD", "FFFFFF"]
        end
      end.render
    end
  end
end

[geekelo]

This file configures an ActiveAdmin interface to manage reports related to card requests. The interface provides options to filter, view, and download reports for Card::Request records within a specified date range. Here’s a breakdown of the key elements:

File: card_request_report.rb

1. Menu Configuration

• menu parent: 'Reports', label: 'Card Request Reports'
  • Places the Card::Request report under the "Reports" menu with the label "Card Request Reports" in the ActiveAdmin interface.

2. Filters and Batch Actions

• config.filters = false
  • Disables the default filters, meaning no sidebar filters will be displayed.
• config.batch_actions = false
  • Disables batch actions, preventing the selection of multiple records for actions like delete or update.

3. Index Page

• index title: "Card Request Reports by Date Range" do

  • Customizes the title and content of the index page for the report.

• panel "Filter Card Request Reports" do

  • Renders a custom form (transactions_by_date_form) that allows users to filter reports by date range and possibly other criteria.

• panel "Report Downloads" do

  • Provides links to download the filtered report data:
    • link_to "Download Detailed CSV": Generates a CSV file containing detailed data for each card request within the selected date range.
    • link_to "Download Summary PDF": Generates a PDF summary of the card requests within the selected date range.

4. Controller

• controller do

  • Customizes the controller actions and behavior for the report.

• before_action :set_date_range, only: [:index]

  • Runs the set_date_range method before the index action to ensure the date range is set based on the user’s input or defaults to the current date.

• def set_date_range

  • Parses and sets the start and end dates for the report based on the user’s input or defaults to the current date.

• def index

  • Retrieves Card::Request records within the specified date range and optionally filters them by status.
  • Responds with the appropriate format (HTML, CSV, or PDF) based on the user’s request.

• def generate_csv(transactions)

  • Generates a CSV file with detailed information for each card request:
    • Includes columns for User ID, External Id, Status, Name, Email, Card Type, Total Amount, Provider Amount, and Bananacrystal Amount.

• def generate_pdf(transactions)

  • Generates a PDF summary report:
    • Displays the date range.
    • Provides a summary table with metrics like the number of denied, pending, approved, and total card requests.
    • Formats the table with a header, centered columns, and alternating row colors for better readability.

Summary:

• This ActiveAdmin setup provides a user-friendly interface for generating and downloading detailed and summary reports of card requests.
• Administrators can filter the report data by date range and status, and download the results as either a detailed CSV file or a summarized PDF.
• The controller handles the logic for processing the reports and generating the downloadable files, ensuring that the data presented is relevant and accurate based on the user's input.

This configuration is particularly useful for administrators who need to monitor, analyze, and export data related to card requests over specific time periods.