An Overview of My Sinatra Project for Flatiron

Carley Tripp — Sun, 02 May 2021 05:59:34 +0000

The second project in the Full Stack Web Development course at Flatiron School is based on Sinatra. The task is to create a basic application centered around a topic of our own interest. It should include MVC architecture and allow users to create, read, update, and delete resources.

Requirements 📋

Use ActiveRecord with Sinatra
Use multiple models
Use at least one has_many relationship on a User model and one belongs_to relationship on another model
Must have user accounts - users must be able to sign up, sign in, and sign out
Validate uniqueness of user login attribute (username or email)
Once logged in, a user must have the ability to create, read, update, and delete the resource that belongs_to user
Ensure that users can edit and delete only their own resources - not resources created by other users
Validate user input so bad data cannot be persisted to the database
BONUS: Display validation failures to user with error messages

Creating CRUD Pokedex 🎉

The concept behind my application is to allow users to create and add Pokemon to a global Pokedex. It's simply dubbed CRUD Pokedex. My inspiration was due partly to the Detective Pikachu trailer and mostly to the long hours I spent playing Pokemon Crystal Version on my bright green Game Boy Color.

Authentication

CRUD Pokedex uses a SQLite3 database paired with ActiveRecord for object relational mapping. Since users must create an account to interact with the app, authentication is necessary. We achieve this with Sinatra sessions and bcrypt, a password hashing gem. Sinatra also handles routing for our web application.

Validations

The application employs the use of validations for all form data submitted. This means that it will not allow any blank inputs, and all user accounts must be created with a unique username and password combination. If these validations fail, the form will not submit and an error message will appear at the top of the page detailing exactly what went wrong.

Wrapping It Up

In order to pass the Sinatra project lab, all functionality listed in the requirements must be present - but this still leaves a lot of room for improvement. Specifically when it comes to application design. CRUD Pokedex is styled using a very basic CSS framework called Spectre.css, but it needs to be polished to achieve a more cohesive, professional look.

Think of it as an alpha prototype. It includes basic functionality but needs a number of features in order to become a seriously engaging application for users. The addition of images, more user interaction, and detailed Pokemon information would help make it appealing for long-time use.

Check out the Github repo for CRUD Pokedex and feel free to submit your own pull requests. Your feedback and contributions are appreciated. ♥️

Creating a CLI Gem for My Flatiron School Project

Carley Tripp — Fri, 23 Apr 2021 00:49:22 +0000

For my first portfolio project, I was challenged to program a CLI application with good object oriented code. I had to scrape a website and write a program that would offer a list of available data and information about that data that went at least one level deep. Sounds easy, right? Wrong. The task was actually quite daunting for a beginner like me.

All of our previous lessons and labs offered pretty direct instructions on what we were supposed to do. Now that I was on my own, I started to panic. Which website would I choose? What kind of methods should I write? Do I really even know how to code?? Fortunately, my senses came back to me after a few minutes (or hours) of freaking out.

I remembered that I had spent weeks preparing for this very moment. All the information I had absorbed from the lessons, labs, and lectures before was still there in my brain. I just needed to fish it out.

Requirements

I was given a few requirements to meet:

Provide a CLI
CLI must provide access to data from a web page.
The data provided must go at least one level deep, generally by showing the user a list of available data and then being able to drill down into a specific item.
The CLI application can not be a Music CLI application as that is too similiar to the other OO Ruby final project. Also please refrain from using Kickstarter as that was used for the scraping 'code along'.
Use good OO design patterns. You should be creating a collection of objects - not hashes.

There were also bonus points up for grab if I could create and publish a gem to RubyGems.

Preparation

After contemplating for some time, I decided on programming a science news reader. I quickly browsed my way over to the Science website in order to check it out. Bingo! It was perfect. The latest news was laid out in a nice order, and each story was contained within a list element that could easily be scraped. Now, I just had to figure out how to make a gem.

There were a number of resources provided to help me get started. Among them was this walkthrough video filmed by Avi. Admittedly, I had to start over a couple of times before getting everything in order, but I ended up successfully creating my first Ruby gem! Awesome.

Writing the code

I began by creating two classes called CLI and Story. The CLI class would be responsible for greeting the user, listing the stories available to read, and providing menu options. I decided to include the scraper methods in my Story class rather than creating a separate class for scraping. This was because my scraper methods were rather small, and the class itself didn't contain much else.

The code quickly came together thanks to my earlier method stubs. If you don't know what method stubs are, they're basically little pieces of code that act as a placeholder for later functionality. For example, instead of the functional code written in the list method pictured above, I originally had something like:

puts "Bees!"
puts "Volcano Story"
puts "Why Science Rocks"

After writing all the necessary code, I was finally ready to publish my gem.

Launch 🎉

Publishing my gem to RubyGems was super easy. Bundler created a rakefile when I made my gem so all I had to do was run 'rake install'. This allowed me to make sure everything was in working order before actually releasing my gem into the wild. When I was satisfied with the program, I used 'rake release' to publish.

You can check the gem out here.

DEV Community: Carley Tripp