snap-cloud / snap-cloud-rails

DEPRECATED -- A prototype Rails-based cloud service for Snap! Go Here →

Cloud

An interactive, project sharing site for Snap!.

What is Snap! Cloud?

This section is TODO

• Snap! GH Repo
• Snap! homepage
• scratch site

Background

The initial design and development of this project was during Spring 2015 for Professor Fox's CS169, "Software Engineering" course at UC Berkeley. The original team members were:

• Alec Guertin
• Arjun Baokar
• Jason Wang
• Linda Lee
• Michael Ball
• Steven Campos

Setting Up

This (currently) project uses Rails 4.2.1 and Ruby 2.2.1, and aims to be always up to date!

The Heroku destination for the app is https://ucbsnap.herokuapp.com

1. CLONE WITH -r git clone -r [email protected]:snap-cloud/snap-cloud.git
2. You should have rvm or similar installed.
3. bin/setup
4. bundle install --without production
5. git remote add heroku [email protected]:ucbsnap.git

Dependencies

• nodeJS (>= v0.10) and npm
  • Used for bower
• Ruby 2.2.1
• imagemagick for testing profile and thumbnail management
• OS X -- if you have brew there will be an install script sometime...

Development Notes

[ TODO: Move this section to a Wiki?]

• GitHub Flow [link needed...]

• The awesome print gem

$ rails console
ap SomeObject

Heroku Deployment

To deploy to Heroku, you should simply need to do a git push heroku master. However, the build process is slightly more complex than a traditional Rails app.

Heroku Deployment uses a custom "build pack"

1. Install nodeJS
2. Post Node install, install bower
3. Then run the normal Ruby buildpack
4. Install with bundler
5. Serve using the Puma (multithreaded) web server

Pre-Reqs to Deployment:

1. Make sure you have a Postgres database added to the Heroku environment.
2. That's it?

License

Please see the file LICENESE for a full copy of the current license for this project (AGPL 3).

snap-cloud-rails's Issues

API - all url form encoded requests

We should support form enconded requests at somepoint...

User should have a /self ID that references the currently logged in user

User::destory needs to handle projects with co-owership correctly.

"Correctly" is semi-TBD.

However, it doesn't seem good to just silently delete projects which you have access to.

Create a S3 Price Expectation List

Need a function to map from rails ids to snap! project names

Snap ids public projects as:
// id is Username=username&projectName=projectname

We need to translate this into DB project id.
Username for now is email.

Consider using `git subtree` instead of `git submodules`

Because they might be better?

I don't know I need to test this.

Sign up age

Only people less than five years old can sign up for the app.

Random Screenshot storage...

I can't attach screenshots to a wiki so I'm putting them here and closing this issue... lulz.

User Credits Page

Everyone in the CS169 needs to have their name on a public page somewhere. ❤️

Better Read Me

Fix the Assets Issues Even More

• We don't want to commit assets to the repo
• heroku should bower install for us
• try using the execjs gem to force heroku to install bower
• update readme for dependency

Fix it so that flash is an app level include

Migrate Pivotal Tracker Tasks to Github

Please tell me there's a script for this?

Projects Table Partial: Find Gem to do nice relative dates

User Confirmations Should Be Enabled At Some Point

Users Auth should use tokens instead of cookies

Refactor: S3 key duplication

Should only exist in config/**

Fix the damn css to use the app file

Include an API proxy endpoint for getting around CORS shit

Pull-Request / Dev Docs

Support Retina Assets

There has to be a gem for this.

User signup needs to ask for DoB (or month / year)

The website should aslo have a checkbox for agreeing to be ToS
(Front end should do validation?)

Need an emailing gem

Current Snap! sends users confirm emails...

Login / Signup views should be AJAX-y popup views

Validate Size of Uploaded Images

Should probably limit pics to < ~2MB?

Set server to use PST time

Normalize all haml files to 2 spaces/tab

Double Check token auth...

Something is iffy and not saving sessions when I save the key...

Collecting more guides:

http://soryy.com/blog/2014/apis-with-devise/

Consider refacotirng API models to be modules

See instructure/canvas-lms

Make /search a route

Saving a project should require auth

-- can only save to your own account

Eventually:
Projects will need a permissions setting

Setup heroku autodeploy

Far off idea: Web Sockets for Communication

We should expose a URL endpoint which when fired will open a connection to a user's project that can trigger snap events.

Better Routes for Users and Projects

• we should be able to go to /:username
• load projects from /:username/:projectname

Reference:
https://scribdtech.wordpress.com/2010/09/01/vanity-user-profile-urls-in-rails/

Heroku Postgres 9.4 is out!!!

Yes!

We should migrate and test. :)

JSON is a supported data type which is some super cool uses... Like storing projects in a DB.

Users table needs a "username" field which is unique and required

min length is 4 characters

lol_nothing

There are lol_nothing links on the dashboard

Add project hooks to verify content received is good

-- mostly content length, and probably we can use a quick checksum.

Project Public Field should default false

DB field shouldn't be blank, and if absent, and no explicitly true, then a project should be private.

Optionally show user emails on profile pages?

sign up != log in

After you sign you you aren't logged in.

Heroku Bower Support

https://gist.github.com/afeld/5704079

Create a dev setup docs section

• ImageMagick
• ways to test pg locally
• notes about dev keys and the like

Heroku Staging Pipeline

https://devcenter.heroku.com/articles/labs-pipelines

API Documentation Page

Rename project's title → Project name

• rename DB column
• check for existing UI usage
• rename all code variables.

Use Swagger For API docs

Because this is cool and will be helpful in the future.

https://github.com/swagger-api/swagger-js

Update rspec rails to >= 3.1

Apparently, 3.1 is required for Rails 4.2, but we've been getting by on 2.x
(Note the deprecation warnings...)
However, the change is a non-trivial

Refactor app controller

Use the helpers function and modules?

Responsive Header