code-corps/deprecated-code-corps-rails-api

Rails API for Code Corps.

deprecated-code-corps-rails-api's Issues

Add error handling for invalid params on login

The API should return an error body to the client application that provides some useful information for error handling on the user's side.

Validation errors do not follow JSON API specs

Add GitHub repository model

We need a model that includes a title, organization, repository name for a GitHub repository. A project should be able to have many of these.

Not sure what the proper name for this is.

Add GitHub repos to project endpoint

We need to consume GitHub repos in Project information, at least on the individual project pages.

Add endpoint for joining a project

This should be an endpoint for contributors.

Add Post model

A Post model is the main activity point in the app. These are of at least a few types: Idea, Issue, Progress, and Task.

Every Post type except for a progress post has a boolean status of open or closed to indicate whether it should show up in the main list of posts. This will help declutter everything, similar to how GitHub works.

A Post should belong to both a Project and a User.

Create GET /project endpoint

We need a GET /project endpoint for an individual project.

Add Markdown to body of Posts

We should be able to handle Markdown on Posts.

Add contributors counts to project endpoint

We should have a counter cache column for the number of contributors to a given project.

Add /user_skills endpoint

We need an endpoint for managing a user's skills. It should ideally handle:

• POST
• DELETE
• and PUT

Add GET /projects endpoint

We need to GET /projects so we can retrieve a list of all them.

Add skills to user endpoint

We should be able to see a user's skills on thier profile.

Reset and forgot password errors do not follow JSON API specs

This is what they look like at the moment:

def render_no_such_email_error
  render json: {errors: {email: ["doesn't exist"]}}, status: 422
end

def render_could_not_reset_password_error
  render json: {errors: {password: ["couldn't be reset"]}}, status: 422
end

I believe these should be replaced either by initializing a ActiveModel::Errors object (so we just serialize them as validation errors), or we should define our own custom errors and have the serializer serialize those.

When creating a user_skill, if the associated skill does not exist, should we be able to create it?

@joshsmith

What is the user interface like in this case? Do we select a skill from a dropfdown/auto-complete when adding it to our profile, or are we also able to create a completely new skill?

Post should include a project's users

We'd like to add the ability to @mention at some point. This will require an includes for a project's user for any Post, since we need to be able to quickly reference a list of associated users for the project.

Add contributors to project endpoint

We want to retrieve contributors with a project.

Add login with email and pass

We need to add an endpoint for logging in with email and password.

Add PATCH endpoint for users

We should be able to update user information.

Add Twitter to user model

A user should be able to enter their Twitter handle.

Add ability to sign up with Facebook to API

Work out access rights for post and comment creation

• When should the user be allowed to create posts for a project?
  • Is it post_type specific? Role-specific? Project type specific? We need to flesh this out.
• When should the user be allowed to create comments for a post?
  • Some overlap with posts here, but also differences, I think.

Add a slugged endpoint for users/organizations

We need to implement something like what's implemented here: http://blog.arkency.com/2014/01/short-urls-for-every-route-in-your-rails-app/

You would hit api.domain.com/:slug and render either a User or an Organization. Since there are more users than organizations (i.e. a likelier hit), we should find users first, and then query for organizations before rendering a 404.

Add forgot password logic

We need to add the ability to reset a password by:

• Entering your email address and clicking a button
• Getting an email with a tokenized URL
• Using the tokenized URL to go to a form to enter a new password and confirm new password
• Submitting form changes the old password to the newly submitted password
• Redirects to sign in page

Change usernames/slugs to allow dashes

A username and slug should be allowed to have any \w word character: an underscore, a letter, or number. It can also have hyphens, as long as the username/slug does not begin or end with it.

A regex like this will probably work: ^[\w](?:[\w_-]*[\w])?$ for validations.

Handle N+1 queries

Set up https://github.com/flyerhzm/bullet to detect existing (and potential future) N+1 queries and fix them.

Add skills with categories

We want a Skill model that includes a title:string and a category. For example, Ruby is in the Development category.

Add validation of profanity in organization slugs

We want to add validation for profanities using the obscenity gem.

Add endpoint to create comments

We should POST to create comments on a post.

Add Project model

A Project should have a:

• title:string
• description:string
• and an icon

Add images for posts and comments

A PostImage or CommentImage should be able to be uploaded as a Base64 encoded file. We'll take the original filename and save that.

We'll be replacing the first occurrence of a string like ![Uploading wx4VIGt.jpg…]() in the client-side with the actual URL of the image. I tested this on Github and if you paste that string and then drop the file in (which generates that string again), it will replace just the first instance of it, every time.

We can create a reference to a post or comment with this model as belongs_to, but it will never be used in a has_many. We should also probably make it belongs_to a User.

The image processing will need to be asynchronous as usual, but we'll have to subscribe to some async stream for it. I think some minimal resizing down should probably be done.

The URL string should absolutely have the ID of the post or comment and the ID of the image. If we ever change URLs, we may have to rely on this (with some downtime) to do URL replacement in our markdown and body text.

But we should be trying to make these URLs as immutable as possible.

User creation doesn't follow JSON API specs

Add ability to @mention a user

A user should be able to @mention users in both a Post and a Comment.

Add project to user's endpoint

We want to see the projects a user is a contributor to.

Add a PostLike or similar model

We want the ability to "like" posts, so we need a way for users to like them. There should probably be a counter cache column for this as well.

Add posts to individual project endpoint

When retrieving an individual project, we should get the posts that project has.

Add icons to projects

We should have an icon created with Paperclip in S3 that's hosted through CloudFront.

Expose `GET /skill_categories`

Initially, I thought it should be GET "/skills", but now that I think about it, since we do have skill categories, we should probably have a GET "/skill_categories", with an include of skills.

That way, through an autocomplete feature, we could fetch the data in a hierarchical form. It could go either way, though.

Add endpoint for creating a post

We need to POST to create a Post.

Add ability to sign up with Github

Add Comment model

A Comment should belong to a User and a Post. It should have a body and a timestamp of some sort.

Add UserSkill model

A UserSkill model needs to relate to User and Skill.

Add GET /user endpoint

We need a GET /user endpoint so we can have user profiles.

Add biographical section to user model

A user should be able to post a short text-only biography.

Switch CanCan to Pundit

https://github.com/elabs/pundit

The existing model needs to be switched, so we can start implementing the Contributor model in #12

Add website to User model

A user should be able to link to their website. Add standard validations for URLs.

Add Contributor model

We need a Contributor model that relates a User to a Project, with some metadata like their status in the project (admin, etc). We should look to GitHub for a good set of statuses.

Should the admin be able to create and delete user_skills for other users through the "/user_skills" endpoint

@joshsmith See title

Add ability to sign up with email and username to API

Add pagination to post endpoints

We should be able to paginate the posts since there may be quite a number them.

Add Markdown to body of Comments

We should be able to handle Markdown on Comments.