MMESS MVP Pull Request

Gemfile

@@ -37,7 +37,7 @@ gem "redis", "~> 4.0"
 # gem "kredis"
 
 # Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
-# gem "bcrypt", "~> 3.1.7"
+gem "bcrypt", "~> 3.1.7"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
@@ -76,6 +76,7 @@ end
 
 # Developer Added Gems
 gem 'dotenv-rails'
+gem 'stripe'
 
 # Suggested Potentially Useful Gems
 # gem 'devise'

Gemfile.lock

@@ -68,6 +68,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
+    bcrypt (3.1.20)
     bindex (0.8.1)
     bootsnap (1.13.0)
       msgpack (~> 1.2)
@@ -132,9 +133,11 @@ GEM
       digest
       net-protocol
       timeout
-    nio4r (2.5.8)
+    nio4r (2.7.4)
     nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
     nokogiri (1.13.8-x86_64-linux)
       racc (~> 1.4)
     public_suffix (5.0.0)
@@ -191,9 +194,12 @@ GEM
       sprockets (>= 3.0.0)
     stimulus-rails (1.1.0)
       railties (>= 6.0.0)
+    stripe (13.2.0)
     strscan (3.0.4)
     tailwindcss-rails (2.0.12-arm64-darwin)
       railties (>= 6.0.0)
+    tailwindcss-rails (2.0.12-x86_64-darwin)
+      railties (>= 6.0.0)
     tailwindcss-rails (2.0.12-x86_64-linux)
       railties (>= 6.0.0)
     thor (1.2.1)
@@ -223,9 +229,12 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-23
+  x86_64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
+  bcrypt (~> 3.1.7)
   bootsnap
   capybara
   debug
@@ -239,6 +248,7 @@ DEPENDENCIES
   selenium-webdriver
   sprockets-rails
   stimulus-rails
+  stripe
   tailwindcss-rails
   turbo-rails
   tzinfo-data

README.md

@@ -1,157 +1,105 @@
-# ValetBike
-
-Smith College CSC223: Software Engineering\
-Starter App for ValetBike project
-
-## Environment Configuration
-
-As you configure your environment you should **keep a log** where you **write down all the steps you take** including **each command you type**. You will inevitably run into errors setting up your development environment and maintaining a meticulous log will allow others to help you troubleshoot. Ignore this recommendation at your own peril, but don't say you haven't been warned :]
-
-Installing Ruby on Rails is not a trivial process. It is the essential first step to developing ValetBike, and it will take you far longer than all the other steps to complete. Be sure to set aside ample time to work through the setup.
-
-### 0. Remember that versions matter
-ValetBike runs on Ruby 3.1.2 and Rails 7.0.3.1. It is essential that you configure your environment to use these precise versions of the language and framework.
-
-### 1. Install Ruby on Rails with MySQL
-
-On Mac it is strongly recommended that you use asdf to install Ruby. On Windows you should set up your environment through the Windows Subsystem for Linux (WSL). The guides below explain how to do so in detail:
-
-- [Mac Ruby on Rails Developer Environment Setup](https://github.com/deadroxy/valetbike/blob/master/notes/mac-setup.md)
-- [Windows Ruby on Rails Developer Environment Setup](https://github.com/deadroxy/valetbike/blob/master/notes/windows-setup.md)
-
-Be sure to complete all the installation procedures in the relevant guide before continuing on to the next step.
-
-### 2. Fork & clone the ValetBike repo
-
-- Click fork in the upper right hand corner of the ValetBike GitHub page
-- This creates a copy of the repository on your personal GitHub account
-- To access this code on your development machine, create a local copy of your fork with:\
-  `git clone https://github.com/<your_username>/valetbike.git`
-- Note: you should run that command when you are in the folder where you want to store the repo\
-  (e.g. `/Users/<your_username>/Development`)
-
-### 3. Prepare the application
-
-- Enter the directory you just created: `cd valetbike`
-- Add `.tool-versions` to app directory to ensure the right ruby is always used: `asdf local ruby 3.1.2`
-- Install required gems with: `bundle install`
-
-### 4. Configure the database environment variables
-
-- Add a file called `.env` to the valetbike root directory
-- Ensure that it includes the credentials you setup when installing MySQL:
-
-```shell
-MYSQL_USERNAME=root
-MYSQL_PASSWORD=YOURPASSWORD
-MYSQL_SOCKET=/tmp/mysql.sock              # For Mac
-MYSQL_SOCKET=/var/run/mysqld/mysqld.sock  # For Windows
-```
-
-### 5. Prepare the database in MySQL
-
-- Use rails to create both the development and test databases with:\
-  `rake db:create`
-- Or use mysql to just create the development databse with:\
-  `mysql -u root -p`\
-  `CREATE DATABASE valetbike_development;`\
-  `exit`
-- Then run the database migrations with:\
-  `rake db:migrate`
-
-### 6. Confirm that the app runs
-
-* Launch the web server using `rackup` or `rails s` (short for `rails server`) or `bin/dev`
-* If using `rackup` open http://localhost:9292 (or http://127.0.0.1:9292) in a browser
-* If using `rails s` or `bin/dev` open http://localhost:3000 (or http://127.0.0.1:3000) in a browser
-* You should see ValetBike welcome page
-
-
-## Assignment #1: Hello Stack, Welcome to ValetBike!
-
-### Brief Background
-You and several other junior engineers have just started at ValetBike, a community tech co-op based in Nipmuc Notch, and you are excited to finally be getting paid to contribute to a meaningful app. During your hiring interview, you said you were comfortable doing full stack programming, but stressed you hadn't worked in Ruby on Rails before. The lead developer thought you were right for the position and promised you a guided tour of the codebase on your first day. However, after your onboarding, you learn they've just gone on leave indefinitely. It also turns out the lead developer was the *only* developer at ValetBike, and now the rest of the team is counting on you and the other new programmers to complete the prototype before the scheduled launch day.
-
-As a fearless software engineer you agree to onboard yourself and attempt to continue the build. You didn't get much information about the architecture or design of the product during your interview. All you remember is that the lead developer had been working with the [ValleyBike](https://valleybike.org) team to iterate on their system which launched in 2018 and that they were using GitHub to collaborate on their codebase.
-
-### Assignment Goal
-Your primary objective is to get your development environment configured so that the existing app will run on your machine. To exceed expectations, you must add at least one feature to the current code. To distinguish yourself, you should add two or more features. See submission guidelines below for complete details.
-
-### How to Begin
-* Create a GitHub account if you don't have one
-* Go to [https://github.com/deadroxy/valetbike](https://github.com/deadroxy/valetbike)
-* Follow the README instructions to configure your environment
-
-### Teamwork Guidelines
-You may work in teams of up to five people to get your environments set up and to modify the code. But you must each submit your own unique environment screenshots via Moodle. If you choose to fork the repo to add features, you can collaborate on the code, but you must each create and submit a record of a unique pull request.
-
-### Ruby on Rails Guides
-You will probably be unfamiliar with the main components of the ValetBike stack like the language (Ruby), the framework (Rails), and the database (MySQL). Luckily the lead developer left links to their favorite books and tutorials for you below. Consult them regularly as you get your bearings in the new environment.
-
-* [Getting Started with Rails](https://guides.rubyonrails.org/getting_started.html)
-* [I Love Ruby](https://i-love-ruby.gitlab.io/)
-* [The Bastards Book of Ruby](http://ruby.bastardsbook.com/)
-* [Why's (Poignant) Guide to Ruby](https://poignant.guide/)
-
-### Exploration Tips
-* Review the files the lead developer left in the `notes/` folder
-* Pay special attention to the environment setup and [app creation](https://github.com/deadroxy/valetbike/blob/master/notes/app-creation.md) guides
-* Use GitHub to dive into previous commits to see what they built so far
-* Use `rails console` to experiment with creating & associating records (objects) from the command line
-  - `s = Station.new(name: "Neu Station", address: "123 Novel Lane", identifier: "45")`
-  - `s.save`
-  - `b = Bike.new(identifier: "1234")`
-  - `b.current_station = s`
-  - `b.save`
-  - `s = Station.new(name: "Ye Olde Statione", address: "101 Historic Way", identifier: "99")`
-  - `s.save`
-  - `b = Bike.new(identifier: "5678")`
-  - `b.save`
-  - `s`
-  - `Station.last`
-  - `Station.first`
-  - `s = Station.first`
-  - `s`
-  - `s.id`
-  - `s.identifier`
-  - `s.docked_bikes`
-  - `s.docked_bikes.count`
-  - `Station.last.docked_bikes.count`
-  - `Bike.first.current_station`
-  - `Bike.last.current_station`
-  - `Bike.find_by(identifier: "1234").update(current_station: Station.last)`
-  - `Station.last.docked_bikes`
-  - `Station.first.docked_bikes`
-
-### Submission Guidelines to Meet Expectations
-1. Get ValetBike running on your development machine
-2. Modify the welcome message
-3. Take a screenshot showing your change works (include browser, console, date/time)
-4. Name the screenshot "youremail-a1-ss.png" or *.jpg (for me it would be "jbrewer-a1-ss.png")
-5. Create a text file called "youremail-a1-team.txt" (for me it would be "jbrewer-a1-team.txt")
-6. List the names of everyone you worked with on this assignment, including your own (for me it would be "Johanna Brewer")
-7. Submit your screenshot and team list via Moodle
-
-### Submission Guidelines to Exceed Expectations or Distinguish yourself
-1. Complete all of the Meets Expectations tasks
-2. Implement one (Exceeds) or more (Distinguished) of the features below
-   - Show number of docked bikes at each station
-   - Create rake task to import station & bike data from csv files
-   - Allow user to view list of bikes
-   - Allow user to switch between station and bike list views
-   - Allow user to reverse sort order of stations or bikes in list view
-3. Commit and push your changes to your fork on GitHub
-4. Create a pull request from your modified fork to the main ValetBike repo
-5. Create a file called "youremail-a1-pr.txt" (for me it would be "jbrewer-a1-pr.txt")
-6. Include a complete link to your pull request as the first line of this file (e.g. "https://github.com/deadroxy/valetbike/pull/1234")
-7. Submit your pull request file along with your screenshot and team list via Moodle
-
-## License
-Copyright 2021-2022, Johanna Brewer
-
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses.
-
+# VectorBike
+
+VectorBike is now live! Visit the site on [Heroku](https://vectorbike-ecfe326f48ab.herokuapp.com/).
+
+## Developed By
+* Molly Neu
+* Molly Daniel
+* Skye Weaver Worster '25J
+* Emma Ruckle
+* Sydney Weisberg
+
+## Development environment setup
+VectorBike requires Ruby 3.1.2 and Rails 7.0.3.1. This guide uses MySQL for database functionality. Set up and start a MySQL database on a socket connection with a username and password.
+
+Create a `.env` file in the repository directory, add it to your `.gitignore`, and include the following:
+```
+MYSQL_USERNAME=<your_username>
+MYSQL_PASSWORD=<your_password>
+MYSQL_SOCKET=<path_to_socket>.sock
+```
+For access to the Stripe API, please reach out to Sydney Weisberg for the secret key. Store the key in your `.env` file as `STRIPE_SECRET_KEY`.
+
+Execute the following commands from your repository directory:
+```rb
+bundle install
+rails db:reset #reconfigures the database
+rails db:migrate #ensures schema is updated
+rake initial_import #loads CSV data, generates pseudo-random data
+rails s #launches the web server
+```
+Navigate to `http://localhost:3000` in a browser, and enjoy!
+
+On each subsequent deployment, only `rails s` is required to launch the page. If changes to the schema, CSVs, or gems are made, perform all commands from `bundle install` onwards before launching.
+
+## VectorBike MVP functionality description
+
+### Account Management
+- Users can create an account, sign in, and log out.
+- On the `Profile` page, users can view and edit their information or delete their account.
+- Users can add funds to their account via Stripe.
+- On the `Profile` page, the user’s ride history is displayed.
+
+### Site Navigation
+- Accessible via a top navigation bar.
+- Homepage includes an overview of VectorBike and a `Rent a Bike!` button linking to the rental page. `Rent` also links to the rental page.
+- `About` page provides detailed information about VectorBike and an about the developers section.
+- `Profile` page displays user-specific details.
+- Site features a footer with contact information.
+
+### Rental Process
+- Users can access the rental page via `Rent a Bike!` on the homepage or `Rent` in the navigation bar.
+- Stations are displayed in list or map view:
+    - Map View: Shows station locations with clickable icons for details and directions. Searchable dropdown allows station selection. The dropdown only shows stations with at least one available bike.
+    - List View: Stations sortable by name, address, or available bikes.
+- Clicking a station opens a rental form to select a bike (charged > 50%) and rental duration.
+
+### Rental Form
+- Options include `Return to Stations` to cancel or `Rent Now!` to complete the rental.
+- Invalid rentals (e.g., no bike selected) do not go through, and the user is shown an informative flash alert.
+- Non-logged-in users are redirected to the login page before proceeding.
+- If a rental is valid, and the user has enough funds, the rental goes through.
+
+### Rental Management
+- After a successful rental, users see a countdown timer and options to return the bike or view active rentals.
+- Users can have up to 5 active rentals.
+- The `View Bike Rentals` button lists active rentals, with links to each rental’s countdown page.
+
+### Returning Bikes
+- Users select a return station from a dropdown in a pop-up.
+- Clicking `Return` processes the return, while `Close` cancels the action.
+- After returning a bike, users see a success screen.
+
+### Ride History and Metrics
+- The `Profile` page lists total biking hours, and the number of rides. Ride history is also displayed.
+- The top ten users with the most riding time have a badge displayed next to their name on the profile page.
+
+### Rental Limits
+- Users can have up to five active rentals.
+- With at least one active rental, users are routed to the `View Bike Rentals` page when they click `Rent` or `Rent a Bike!`.
+- Users with fewer than five rentals can rent additional bikes; users at the limit see a message indicating they have reached the maximum number of rentals.
+- Once all rentals are returned, users are routed to the stations list when they click `Rent` or `Rent a Bike!`.
+
+### Recommended walkthrough
+- Navigate to the sign up page, and sign up for an account.
+- Add funds to your account via the `Add Funds` button. We recommended putting at least $10.00 into your account. Use the card number `4242 4242 4242 4242` in the Stripe test API, provide a reasonable expiration date for the card, and fill all other fields with random data.
+- Navigate to the rent page.
+- Use the toggle at the top of the page to view the stations list and the embedded map/search function.
+- Return to list view.
+- Sort the list of stations by either name, address or number of available bikes by clicking on the corresponding part of the header.
+- Select a station with at least one bike by clicking on its row (the number of available bikes is shown at the right end of each station’s row).
+- In the rental form, select a bike and a duration.
+- Press `Rent Now!`.
+- Navigate away from the success page.
+- Return to the rent page, observe it is the current rentals page rather than the station list.
+- Click `Rent Another Bike` and repeat the rental process.
+- Click `View Active Rentals` and observe that you now have two active rentals.
+- Click on one of your rentals.
+- Click the `Return Your Bike` button to start a bike return.
+- Select the station you would like to return the bike to (we suggest Florence Bank station, the first station in the list when it refreshes).
+- Click on `Rent` in the nav bar. Repeat the return steps to return your second rental.
+- Click on a station you returned a bike to and confirm that it is once again listed in available bikes.
+- Navigate to `Profile`.
+- Observe that you now have two past rides.
+- Click the `Delete Profile` button
+- Confirm the deletion of your profile in the pop up.