Merge pull request #12 from cs169/main

Iteration 1-3

Author: cycomachead

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+# General Info
+
+- [Pivotal Tracker Story](https://www.pivotaltracker.com/story/show/########)
+- [ ] Breaking?
+
+# Changes
+
+Explain your changes here (in such a way that you would understand why you made them a year from now).
+
+# Testing
+
+Explain how you tested your changes.  If testing is not necessary, explain why.
+
+# Documentation
+
+Does this PR require documentation.  If so, explain where it can be found.
+
+# Checklist
+
+- [ ] Name of branch corresponds to story

.github/workflows/main.yml

@@ -0,0 +1,47 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_PASSWORD: password
+        ports:
+          - 5432:5432
+    runs-on: ubuntu-latest
+    env:
+      DB_USER: postgres
+      DB_PASSWORD: password
+      RAILS_ENV: test
+      RUBY_ENV: test
+      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}
+      CANVAS_URL: http://bcourses.test.instructure.com/
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3.0
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        rails db:create
+        rails db:migrate
+        bundle exec rspec
+    - name: Download and install Code Climate test reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+    - name: Run before-build command
+      run: ./cc-test-reporter before-build
+    - name: Run after-build command
+      run: |
+        ./cc-test-reporter after-build --exit-code $?
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

.github/workflows/swagger_validate.yml

@@ -0,0 +1,25 @@
+name: Swagger
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request: {}
+
+jobs:
+  swagger:
+    runs-on: ubuntu-latest
+    name: Validate Spec
+    services:
+      swagger-editor:
+        image: swaggerapi/swagger-editor:next-v5
+        ports:
+          - 80:8080
+    steps:
+      - uses: actions/checkout@v2
+      - name: Validate Swagger Spec
+        uses: char0n/swagger-editor-validate@v1
+        with:
+          definition-file: app/assets/swagger/swagger.json
+          ignore-error: app/assets/swagger/shouldIgnoreError.js

.gitignore

@@ -67,3 +67,9 @@ yarn-debug.log*
 /storage/*
 !/storage/.keep
 /public/uploads
+
+/config/master.key
+
+/config/credentials/production.key
+
+.DS_Store

Dockerfile

@@ -0,0 +1,62 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.3.0
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libvips pkg-config
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+# Final stage for app image
+FROM base
+
+# Install packages needed for deployment
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libsqlite3-0 libvips && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN useradd rails --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER rails:rails
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

Gemfile

@@ -0,0 +1,97 @@
+source "https://rubygems.org"
+
+ruby "3.3.0"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.1.3"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use postgres for all env dbs
+gem "pg"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", ">= 5.0"
+
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Redis adapter to run Action Cable in production
+# gem "redis", ">= 4.0.1"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ windows jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+gem "lms-api"
+
+
+
+# Use Active Storage for file uploads [https://guides.rubyonrails.org/active_storage_overview.html]
+# gem "activestorage", "~> 7.0.0"
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible [
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+gem 'bootstrap', '~> 5.3.2'
+gem 'jquery-rails'
+gem 'sassc-rails', '~> 2.1'   #dependency for bootstrap
+gem 'json'
+
+# Used to make http requests.
+gem 'faraday'
+
+# Used to allow dot notation of hashes.
+gem 'ostruct'
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri windows ]
+  gem 'dotenv-rails'
+end
+
+group :test do
+    gem 'rspec-rails'
+    gem 'guard-rspec'
+    gem 'simplecov', '~> 0.17.1' , :require => false
+    gem 'codeclimate-test-reporter'
+    gem 'cucumber-rails', :require => false
+    gem 'cucumber-rails-training-wheels'
+    gem 'database_cleaner'
+    gem 'timecop'
+    gem 'webmock'
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  #for debug
+  gem 'byebug'
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end