StockEye

Design

Table of Contents

• (1) Introduction
• (1.1) Purpose
• (1.2) Scope
• (1.3) Definitions
• (1.4) References
• (2) Decomposition Description
  • (2.1) Software Architecture
  • (2.1.1) Package Diagram
  • (2.1.2) Subsystems
  • (2.2) Concurrent Process Decomposition
• (3) Interface Description
  • (3.1) Module Interface
  • (3.1.1) HomeView
  • (3.1.2) TrendingView
  • (3.1.3) UserLoginView
  • (3.1.4) RegistrationView
  • (3.1.5) AccountSettingsView
  • (3.1.6) WatchlistView
  • (3.1.7) ManageWatchlistView
  • (3.1.8) EditWatchlistView
  • (3.1.9) StockView
  • (3.1.10) FilterStockView
• (4) Detailed Design
  • (4.1) Module Detailed Design
  • (4.2) Documentation
  • (4.2.1) Front End
  • (4.2.2) Back End
• (5) Change History

(1) Introduction

This document is written following the guidelines of the IEEE Recommended Practice for Software Design Descriptions.

The following provides an overview of the StockEye Design.

(2) Decomposition Description

This section describes the decomposition of the system in three different forms:

• Cohesive modules are formed by grouping data and functions, which are then displayed in their corresponding class and package diagrams.
• Concurrent processes are extracted from the decomposition, and briefly outlined. In this case, as it is web-based, all served pages are considered concurrent processes.
• The storage format of persistent data is identified.

(2.1) Software Architecture

(2.1.1) Package Diagram

(2.1.2) Subsystems

TweetStream Package Layering & Encapsulation

Database Schema

Package	Responsibilities	Associated Entities
User	Creates user objects that contain a user’s profile information (name, password, etc.) and stores them in the database Performs user authentication UserController allows each user to perform actions on the StockWatch package	UserLoginView AccountSettingsView RegistrationView UserController AccountSettingsController RegistrationController
StockWatch	Creates stock objects with attributes sentiment, price and name, stores them in the database, and displays them for the user using StockView. Additionally, the user can filter the stocks shown with the attributes listed above. Sentiment attribute on stock object is retrieved from machine learning package. Provides each user with an interface to view stocks, add them to watchlists, and perform actions on them (adding, deleting, or editing stocks).	WatchlistView StockView FilterStockView FilterStockController WatchlistController StockController
Machine Learning Model	Scan Tweet text for stock ticker. Tokenize tweet text. Normalize words. Denoise data. Determine sentiment from cleaned and tokenized data. Construct Sentiment_Update object	Sentiment
TweetStream	Initialize connection to the Twitter Stream API and request JSON objects that match a stocks content filter. Observe the Twitter Stream API through Tweepy StreamListener. Construct Tweet objects from attributes within Tweepy Status object. Pass Tweet objects into the Machine Learning Model Package.	Status Tweet
Database	Storing concurrent information in the SQLite database. Proving an interface for querying, modifying and deleting entries in the database.	user stock watchlist

(2.2) Concurrent Process Decomposition

StreamListener

Concurrent process to handle Status objects pushed through the Twitter Stream API. Forwards newly created Tweet objects to the Machine Learning Model for evaluation, ensuring up to date sentiment values within the database.

Interfaces

Interface	Identification	Purpose
Home View	HomeView	An interface that greets, and informs the user about StockEye’s functionality.
Login View	UserLoginView	An interface for the user to enter username or email address and password for login. Additionally, a check box a remember me checkbox with a forgot your password link.
Account Registration View	RegistrationView	To let the user register for an account with a username, password, and email. A confirm Registration button to confirm the registration. Additionally, a login button is presented if an account already exists.
Profile View	AccountSettingsView	Allows the user to change their user information on their account, such as the email and password they wish to have linked to their account.

(3) Interface Description

This section provides prototypes and details for the StockEye interface.

(4) Detailed Design

(5) Change History

The StockEye Design is a living document, changing as the project progresses. While Google Docs is used to track the editing history, the StockEye Design includes references to major changes of the document within itself.