##Problem statement
Create a simple application that prints out a report detailing the "weights" of the "classic" files of a user, categorized by file type. "Classic" files are those exposed by the Open API and they are visible under the "Files and Folders CLASSIC" on the left menu.
The basic weight of a file is equal to it size in KB multiplied by a "specific gravity" based on the type. The report should list for each category (if any file present) the number of files, the type, the weight of all the files of the same category (including the gravity) plus two extra lines showing the total weight of all files and the total "gravity displacement", which is the the difference between the total weights including gravity and the total ideal weights (1).
File types are Songs, Videos, Documents (office, openoffice,...), Text, Binaries, Others Gravity is 1.1 for Documents, 1.4 for Videos, 1.2 for Songs, 1 for the rest any other file types, with the results roundedup to the upper 0.05. A fixed gravity of 100 is added to Text files.
##System Dependencies
- Ruby v2.1.5
- Sinatra v1.4.5
- Sinatra Flash and Sinatra Partials
- HTTParty v0.13.3
##To Run the App Locally
You will need to have Ruby installed along with Gem and Bundle (I use Ruby Version Manager and you can get started here) and you have an account with Workshare (email and password).
#####From the commandline:
-
To run the app on your local machine clone the repository: git clone https://github.com/ruthearle/file_gravity.git
-
Navigate to the newly created repository: cd file_gravity
-
Install dependencies: bundle
-
Start the app: rackup
-
Then go to your favourite browser and type: http//localhost:9292
-
Input your Workshare registered email address and password and delight!
##How to run the test suite File Gravity is fully tested with Rspec/Capybara (versions 3.2.0 and 2.4.4, respectively).
#####From the commandline:
- Navigate to the directory (see step 2. above) and type: rspec
##Improvements?
I would make two improvements to the app.
Firstly, the app has a Preek smell of eight. Four of those smells come from the #basic_weight method in the .FileMeta class. Given more time I would refactor the code to reduce the amount of statements the #basic_weightmethod has and remove the duplicate method calls, which in turn would eliminate the smell.
Secondly, I would fully test and implement checking for incorrect input of email and password and redirecting back to the login page. At the moment when incorrect credentials are used the app throws a http 500 status code because the FileMeta::Login method is unable to save the auth token that it needs in order for the app to return a status code of 303. I have patched this by creating a custom error page that has a useful message and link for the person to try and login again.