All Pay Auction

All Pay Auction implements an all-pay auction where every bidder pays their bid, regardless of winning. The highest bidder wins, but all participants pay their bids. The seller sets a closing date for the auction, after which no bids are accepted. At settlement, the auctioneer collects payments from all bidders. This application is currently in active development and not yet production-ready.

Current State (Debug Mode)

⚠️ The application is currently configured for debugging and testing purposes. Do not deploy to production without addressing the following:

• Manual Auction Settlement: Sellers can manually settle auctions. This feature must be disabled in production to ensure automated, time-based settlement.
• Stripe Sandbox Keys: The Stripe API keys are configured for the sandbox environment. Replace with live keys for production use.

---

Prerequisites

Before deployment, ensure the following are installed:

• Ruby 3.3
• Rails 7.2
• PostgreSQL
• Git
• Docker (optional, for containerized deployment)
• Heroku CLI (for Heroku deployment)

Deployment

1. Create a Heroku App

# Install Heroku CLI
curl https://cli-assets.heroku.com/install.sh | sh
heroku create your-app-name

2. Install Required Add-Ons

heroku addons:create heroku-postgresql:hobby-dev
heroku addons:create scheduler:standard
heroku addons:create heroku-redis:mini

3. Set Environment Variables

heroku config:set RAILS_ENV=production \
  STRIPE_PUBLISHABLE_KEY=your_key \
  STRIPE_SECRET_KEY=your_key \
  STRIPE_WEBHOOK_SECRET=your_key \
  STRIPE_PROD_WEBHOOK_SECRET=your_key \
  RAILS_ENV=production \
  AWS_ACCESS_KEY_ID=your_aws_key \
  AWS_SECRET_ACCESS_KEY=your_aws_secret \
  GOOGLE_SECRET_ACCESS_KEY=your_google_secret \
  GOOGLE_CLIENT_ID=your_google_id

4. Deploy Code To Heroku

git push heroku main

5. Database Migrations

heroku run rails db:migrate

6. Create cron job for auction settlement

• Go to the Heroku application dashboard
• Click on resources, and then navigate to Add-on Services
• Click on Heroku Scheduler, and add job
• Choose a proper interval according to your scheduler plan
• Add the command rake scheduler:close_and_settle_auctions

Tech Stack

• Frontend: HTML, CSS, JavaScript
• Backend: Ruby on Rails 7.2
• Language: Ruby 3.3
• Database: PostgreSQL
• Version Control: Git/GitHub
• Containerization: Docker

Environment Variables

# Required for production
STRIPE_PUBLISHABLE_KEY
STRIPE_SECRET_KEY
STRIPE_WEBHOOK_SECRET
STRIPE_PROD_WEBHOOK_SECRET
RAILS_ENV=production
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
GOOGLE_SECRET_ACCESS_KEY
GOOGLE_CLIENT_ID

🔐 Environment Variables – Google OAuth Setup

This section explains how to generate your Google OAuth credentials, which are required for users to log in using Google.

✅ Steps to Create Google Client ID and Secret

1. Create a Google Account
   https://accounts.google.com

2. Visit the Google Cloud Console
   https://console.cloud.google.com

3. Create or select a project in the top nav bar.

4. Go to the sidebar menu → “APIs & Services” → “Credentials”

5. Click “+ Create Credentials”
   → Select “OAuth client ID”

6. On the setup screen:

   • Application type: Choose Web application

   • Name: (e.g., "All Pay Auction Web")

   • Authorized redirect URIs: Add the following URIs:

     http://localhost:3000/auth/google_oauth2/callback
     https://your-production-url.com/auth/google_oauth2/callback
     

     Example: https://all-pay-auction3-478f271f12bd.herokuapp.com/auth/google_oauth2/callback

7. Click Create, then copy the following:

   • Client ID
   • Client Secret

---

☁️ Environment Variables – Amazon S3 Setup

This section explains how to configure Amazon S3 for use with Active Storage in a Rails app.

---

✅ Steps to Set Up an S3 Bucket

1. Create an AWS Account
   https://aws.amazon.com/

2. Navigate to the Amazon S3 service

3. Click “Create bucket”

4. Configure your bucket:

   • Name: Choose a unique name (e.g., swirl-allpay)
   • ACLs: Enable ACLs
   • Block Public Access: Uncheck “Block all public access”
   • Click “Create bucket”

---

⚙️ Update config/storage.yml

Replace [bucket-name] with your actual bucket name:

amazon:
  service: S3
  access_key_id: <%= ENV["AWS_ACCESS_KEY_ID"] %>
  secret_access_key: <%= ENV["AWS_SECRET_ACCESS_KEY"] %>
  region: us-east-2
  bucket: [bucket-name]
  public: true

---

🔐 Set IAM Permissions

1. Go to the IAM section in AWS Console

2. Click “Policies” → “Create policy”

3. Choose JSON view and paste the following and replace [bucket-name] with your actual bucket name:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowObjectOperations",
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:PutBucketAcl",
        "s3:ListBucket",
        "s3:DeleteObject",
        "s3:PutObjectAcl"
      ],
      "Resource": "arn:aws:s3:::[bucket-name]/*"
    },
    {
      "Sid": "AllowListBucket",
      "Effect": "Allow",
      "Action": "s3:ListBucket",
      "Resource": "arn:aws:s3:::[bucket-name]"
    }
  ]
}

4. Click Next, then name the policy (e.g., S3AllPayAccessPolicy)

---

👤 Create IAM User

1. Go to Users → Create user

2. Name your user (e.g., swirl-user)

3. Select “Attach policies directly”

4. Find and attach the policy you just created

5. Complete the wizard and Create user

---

🔑 Create Access Keys

1. Select your new IAM user

2. Click “Create access key”

3. Choose “Other” as the use case

4. Click “Next”, then Create access key

5. Save the Access Key ID and Secret Access Key

---

Documents

Team Working Agreement

Web Application Link

Deploy to heroku: https://all-pay-auction3-478f271f12bd.herokuapp.com/

Note: The current heroku deployment is deployed using the test-google-2 branch

Code Quality and Test Coverage Reports

Code climate: https://codeclimate.com/github/SIRL-TAMU/all-pay-auction

Test Coverage Status

Test	Status
BDD (cucumber)	Work in progress (adding more tests)
TDD (rspec)	Work in progress (adding more tests)
Code style (rubocop)	100%
Coverage report	100%

Update (2/24): Cucumber rspec bugs fixed. Currently working on adding more tests.

• TDD tests: run bundle exec cucumber in docker container app-1

• BDD tests: run bundle exec rspec in docker container app-1

• Test coverage run rails test in docker container app-1

• Coverage report generated in coverage/index.html in all-pay-auction repository.

• Code style Rubocop: run rubocop in docker container app-1