Write some Software

The creation of RESTful API using Ruby, which utilizes the Twitter API to provide several pieces of unique functionality. The API will need to provide a standard mechanism to register and manage a user account. There is NO requirement to provide a front-end for this currently, i.e. NO HTML, CSS, JavaScript is required and NO requirement to provide OAuth capability -- users will input their app tokens manually which can then be utilised by the app to make Twitter requests on the users behalf. Additionally there will need to be a series of scripts which can be run via a cron job on behalf of ALL registered users every X minutes (details below). Full details and pseudo-logic for this will be provided in an API spec once the project has been won. Expected API Calls: Auth & User Management ============= POST /register /login /reset-password /configure-token /logout Basic CRUD Actions (all against authenticated user, persisted) ============= POST /smart-follow-keyword (Adds keyword(s)) GET /smart-follow-keyword (List all keywords) DELETE /smart-follow-keyword (Removes a keyword) POST /smart-follow-target-user (Adds target user(s)) GET /smart-follow-target-user (List all target users) DELETE /smart-follow-target-user (Removes a target user) POST /schedule-tweet (adds a tweet to queue for sending, validates against 140 character limit) GET /schedule-tweet (lists ALL my scheduled tweets, sent or in queue) DELETE /schedule-tweet (deletes a queued tweet. NOTE: can only delete queued tweets, not those which have already been sent, i.e. there’s NO requirement to delete from Twitter) Twitter Actions (all against authenticated user) ============= PUT /smart-follow (follows all users who match the criteria as per GET /smart-follow-kewyords & GET /smart-follow-users matching additional X criteria) PUT /smart-unfollow (unfollow all users who I’ve followed via PUT /smart-follow matching additional X criteria) PUT /send-tweet (looks through all scheduled tweets and determines if a tweet should be sent based on date, if so, the Tweet is sent) Cron Scripts (run on behalf of ALL registered users) — these should be accessible by the root user only ============= RUN for ALL registered users: PUT /smart-follow (every X minutes) RUN for ALL registered users: PUT /smart-unfollow (every X minutes) RUN for ALL registered users: PUT /scheduled-tweet (every X minutes) NOTE: (if a users token is no longer Authorized, or they do not have Twitter tokens they should be flagged as invalid and no longer processed by the Cron Scripts) Project Management: - API specification will be provided with request / response formats (JSON) and pseudo logic - Trello board to collaborate and answer any questions etc. Deliverables: - Full API conforming to spec and tested - Efficient usage of the Twitter API — i.e. correct usage of parameters like since_id / max_id to fetch deltas and speed up queries etc. - Secure (modern/secure password hashing, SQL should be parameterized!, authorisation checked otherwise HTTP 401 returned etc.) - Example client code to call each of the APIs to prove validity. Completely the developers choice how they want to do this, example could be cURL, PostMan export, Paw file, javascript, ruby scripts. etc. - Steps to install / run on a linux server Required Technologies: - Ruby - MySQL (and a sensible abstraction library/approach to avoid SQL injections) - API Framework, ideally Grape but if there’s experience in others happy to go with those instead - Standard REST auth framework/approach e.g. Devise/Warden (NOT a custom one using outdated MD5 hashing or browser based cookies etc.)