jamiejpace/enigma

Enigma

Table of contents

• General info
• Self Assessment
• Screenshots
• Learning Goals
• Technologies
• Setup
• Contact

General info

This project uses Ruby to build a tool for encrypting and decrypting messages.

Self Assessment

Based on the rubric found at https://backend.turing.edu/module1/projects/enigma/rubric, my self assessment is that this project meets expectations in all categories.

Screenshots

Learning Goals

• Practice breaking a program into logical components
• Build classes that demonstrate single responsibilities
• Test drive a well-designed Object Oriented solution
• Work with file i/o

Technologies

Project is created with:

• Ruby version: 2.7.2

Setup

To run this program, save a copy of this repository locally. In the MacOS application 'Terminal,' navigate into the enigma directory. Then, run it using ruby (note: '$' is not typed).

1. Clone the repo using the web url:

   $ git clone https://github.com/jamiejpace/enigma
   

   or with a password-protected SSH key:

   $ git clone [email protected]:jamiejpace/enigma.git
   

2. Change into the directory:

   $ cd ../enigma
   

3. Enter the message you would like to encrypt into the message.txt file, then run the encryption by entering the following into the terminal:

   $ ruby ./lib/encrypt.rb message.txt encrypted.txt
   
   

4. You can then decrypt the message by entering the following into the terminal using the same key and date used in the initial encryption:

$  ruby ./lib/decrypt.rb encrypted.txt decrypted.txt <key> <date>

Contact

Created by

• @jamiejpace

✨ feel free to contact me! ✨