Document Plan. Social Media Geolocation App. Robert McCaffrey, Matt Feld, Taylor Neal, David Kwon BLIPME

Transcription

1 BLIPME Document Plan Social Media Geolocation App Robert McCaffrey, Matt Feld, Taylor Neal, David Kwon Blip is a social app aimed at combining new technology and design in a simple way to make going out more fun for college kids

2 BLIPME INTRODUCTION: PROJECT CONCEPT: Blip is a social networking phone application that focuses on the sharing of geolocation data between peers. Our project will encompass the development of an Android version of the application. Upon opening the application, the user will be prompted to either log-in or register. The user will required to be logged-in with an authorised identity in order to use the application s features. Once logged in, a map of the nearby area will be presented to the user. Overlapping this map will be icons representing people who have chosen to share real-time location data with the user for a specified amount of time. The icons will be placed on the map according to the current location of the corresponding user s phone. At the bottom of the screen is a button that may be employed by the user to likewise post his or her current location for a specified amount of time. The user will choose from a list of the user names of friends with whom he or she would like to share the location information. These friends will be able to see the user s real time location on their map until the specified amount of time concludes, at which time the information will no longer be available until the user decides to share it with these friends again. Upon pressing a virtual button on the top right-hand corner of the screen, the user will be brought to a friends list screen, where the user may peruse his or her list of friends. It is at this screen that the user will be able to add user names to his/her friends list. The user may only share location information with the accounts listed in the user s friends list.

3 BLIPME 1.ARCHITECTURE: 2.DECOMPOSITIONS: MODULES MVC Architecture:

4 WEBMANAGER: The Web Manger communicates with the backed provided by the Client. The Node.Js server communicates via JSON through HTTP POST and GET requests. The Web Manager uses String and JSON parser in order to interpret and create HTTP requests Model: Model layer communicates with our Web Manager. Which defines 1. User: A User defines a friend by Name, , phone, unique id and bliprequested( asked for a blip from you) 2. FriendManager: which retrieves friend list using the WebManager 3. BlipModel: Defines a Blip i.e. Geo-location, Timer, Message, Sender, Recipients etc. 4. BlipManager: Manages incoming and outgoing Blips with WebManager 5. Authenticator: provides user authorisation token after login/registration 6. BlipSampler interacts with authenticator, user, BlipManager and FriendManager VIEW: Layouts define the visual structure of the user interface for our activity s. The system declares UI elements in XML. Android provides a straightforward XML vocabulary which quickly designs UI layouts and screen elements similar to way we create web pages in HTML. LAYOUTS: 1. activity_login.xml 2. activity_main.xml 3. cutom_marker.xml 4. footer_repeat.xml 5. fragment_item_grid.xml 6. fragment_item_list.xml 7. fragment_map.xml 8. friends.xml 9. friends_row.xml 10. friends_section.xml 11. header_gradient.xml

5 12. list_header.xml 13. list_row.xml 14. login.xml 15. register.xml 5-7: Map and Blip fragment view for viewing incoming and sending outgoing blips. 8-10: Friend List view 14-15: Login and register view for user login and new user registration respectively. 1-4, 11-13: Sub xml views for the main views described above. CONTROLLER: FriendList: FriendListActivity o Activity for selecting friends when sending a Blip FriendsListAdapter o Corresponds Friends data to the views BlipFeedAdapter o Adapter for the BlipFeed View BlipFeedFragment o Generates the List MainBlipArray o Class holding our array list of BlipModels that is used throughout the app SmartFragmentStatePagerAdapter o Stores the MapFragment and the BlipFeed Fragment. ViewPagerAdapter o In charge of putting the fragments onto the containers Map:

6 MapFrament o Creates Map with Blip markers, user location communicates with BlipFeed LoginAndRegistrations: LoginActivity o RegistrationActivty o Processes: Multiple Threads: Creates login screen, login user via Authenticator Creates registration screen, registers user via Authenticator Worker Threads. Android is a single thread model, therefore anytime we preform operation that are not instantaneous we must back a separate thread: UI Thread New Blip data is one of these data points. New incoming Blips are handled by creating a UI thread in order to handle adding in a new Blip marker on the map AsyncTask Allows for asynchronous work on our Login and Registration views. It performs blocking operations in a worker thread and then publishes the results on the UI thread. It performs the work in doinbackground() and runs in the UI thread, so we can safely provide helper Dialogs and retrieve user information. Server Communication All server communication is done asynchronous connection by using HTTP requests. Data The Data for this project was provided by the Client. Therefore all backend data was handled by the client. For our project we interpreted and applied this data to the application. This data came in the form of what we have defined as a Blip: Description: A Blip is user and geolocation tag that contains longitude, latitude, user information, and a self destruct timer. Functionality: Users send Blip to each other. The application interrupts the blips sent between friends and produces a map labelled with marker showing a friends location as shown in the screenshot. Relationship: Blips are related to each other only by the user who has sent or received the

7 3.MODULE DESCRIPTION: Name: WebManager Type: Access Form Node: Article Manager Processor Description: The Web Manger communicates with the backed provided by the Client. Attributes: Author Name, Reviewer Name Resources: None Name: newpostrequest() Arguments: String url,string[] names, Object[] values,string auth_token. Returns: HTTPResponse Description: Sends a new POST request., returns HTTP response Exceptions: getstacktrace() if anything goes wrong server side. Flow of Events: 1. Create HTTP client 2. Create HTTP Post 3. Execute HTTP request. Name: newgetrequest() Arguments: String url, String[] names, String[] values, String auth_token. Returns: response, which is a JSON response from the server. Description: Sends a new GET request. Pre-condition: None Post-condition: None Exceptions: RuntimeException(). Flow of Events: 1. Create HTTP client 2. Create HTTP Post 3. Execute HTTP request. Name: getjsonbody() Arguments: (HttpResponse response) Returns: JSON Object Description: Parse HTTP response to JSON object Pre-condition: None

8 Post-condition: None Exceptions: Exception(). Name: getstringbody() Arguments: (HttpResponse response) Returns: String Description: Parse HTTP response to JSON object Pre-condition: None Post-condition: None Exceptions: Exception(). MODEL: Name: User Description: Creates a User (friend) Attributes: String name, String , String phone, String id Resources: None Name: isbliprequested() Arguments: None Returns: Boolean Description: If this user has requested a blip from you Name: User() Arguments: 1. String name, String 2 String name 3 String name,string id,boolean requested 4 String name, double phone

9 Description: Four separate setters. Pre-condition: None Post-condition: None. Name: getname(),get ,getid Arguments: None Returns: name. ,id respectively Description: Three separate getters. Pre-condition: None Post-condition: None. Name: FriendManager Description: retrieves friend list using the WebManager Attributes: Author Name,Reviewer Name Resources:None Name: getfriends() Arguments: None Returns: HTTPResponse Description: Returns an array of Users(friends) Exceptions: Server Response Error. Flow of Events: 1. Create GET request 2. Execute GET request sending to WebManager 3. Interrupt response 4. Create friend list and return. Name: BlipModel Type: - Node: - Description: Defines a Blip i.e. Geo-location, Timer, Message, Sender, Recipients etc Attributes:

10 1. String name 2. String type, String sender, boolean isstory,datetime time,user[] recipients, double latitude, double longitude, String message Resources: None Name: getsender(),getrecipients(),getisgroupheader(),getendtime(),gettype(),isstory(),getlatitude(),getlongitude)_ Arguments: None Returns: sender,recipients,isgroupheader,endtime.getmillis,type,isstory,latitude,longitude,message respectively Description: Getter functions. Name: BlipManager Node: - Description: Manages incoming and outgoing Blips with WebManager Attributes: None Resources: None Name: getincomingblips(),getoutgoingblips(),getallblips(), Arguments: None Returns: BlipModel array Description: Getter functions Exceptions: Server Response Error. Flow of Events: 1. Calls getblips with incoming, outgoing, respectively 2. Returns Response Name: getblips Arguments: String type Returns: BlipModel array Description: Given input type incoming, outgoing or both communicate with return response. WebManager and

11 Exceptions: Server Response Error. Flow of Events: 1. Create Type for HTTP request 2. Communicate with WebManager 3. Create JSON response and parse into a Blip Array Name: AESPassEncryptor Type: AES encryption scheme Node: - Description: Encryption and Decryption of byte, cipher respectively with default key of 32 byte length Attributes: None Resources: AES encryption scheme, Key = "ZhketJNHrmGC5upwYckG4Ky1fhHJyZAD" Name: encrypt() Type: byte Arguments: byte[] ivbytes, byte[] keybytes, byte[] textbytes Returns: cipher Description: Creates Cipher. Name: decrypt() Type: byte Arguments: byte[] ivbytes, byte[] keybytes, byte[] textbytes Returns: byte array Description: Decrypts Cipher.

12 Name: encrypt() Type: String Arguments: String text Returns: String Description: Concatenates String with zeros with 32 Byte length Exceptions: getstacktrace(). Name: decrypt() Type: String Arguments: String Text Returns: byte array Description: Removes concatenation of String with zeros with 32 Byte length back to original form. Exceptions: Exception. CONTROLLER: Name: FriendsListActivity Description: Activity for selecting friends when sending a Blip Attributes: None Resources: HashMap, List Name: oncreateoptionsmenu Type: Boolean Arguments: Menu menu Returns: true Description: Inflates Top Menu Pre-condition: Layout menu_friends_list must be initialised. Exceptions:None Flow of Events: 1. Create Menu Inflate object

13 Name: oncreate Type: void Arguments: Bundle savedinstancestate Description: Setting up scrolled view for friends list Exceptions:None Flow of Events: 1. Create The Gestures 2. Create View Name: ontouchevent Type: boolean Arguments: MotionEvent event Returns: Boolean Description: Event handler for Gesture Detector Exceptions:None Name: updatelist Type: void Arguments: None Description: Updates view to correspond to new data Pre-condition: View must already be create. Exceptions:None Flow of Events: 1. Wipe current data 2. Recreate List with new data 3. Recreates a new view Name: displaylistitem() Type: void Arguments: None

14 Description: helper function to display list to the views Name: populatelist() Type: List<String> Arguments:None Returns: List of Friends Description: Pulls User(friends)data from model Name: getrecent() Type: List<String> Arguments:None Returns: List Friends Description: Pulls recent Blip data from model Name: getrequests() Type: List<String> Arguments:None Returns: List of Blip request Description: Pulls requested Blip data from model Name: SideIndexGestureListener extends GestureDector.SimpleOnGestureListener Arguments: None Returns: BlipModel array Description: Getter functions

15 Exceptions: Server Response Error. Flow of Events: 1. Calls getblips with incoming, outgoing, respectively 2. Returns Response Name: FriendsListAdapater Description: Corresponds Friends data to the views Attributes: None Resources:None Name:getRows(),getCount(),getItem(),getItemId(),getViewTypeCount()getItemViewType() Arguments: None Returns: int Description: Getter functions. Name: getview extends GestureDector.SimpleOnGestureListener Arguments: int position, View convertview, ViewGroup parent Returns: View Description: Returns View of Friend List Activity Name: BlipFeedAdapter Node: - Description: Adapter for the BlipFeed View Attributes: Context context Resources: ArrayList

16 Name: addsentblip Type: Void Arguments: BlipModel Description: Add outgoing blip to the list Name: addincomingblip Type: Void Arguments: BlipModel Description: Add incoming blip to the list Name: addstoryblip Type: Void Arguments: BlipModel Description: Add story blip to the list Name: removesentblips Type: Void Arguments: BlipModel Description: Remove outgoing blip from the list

17 Name: removeincomingblips Type: Void Arguments: BlipModel Description: Remove incoming blip from the list Name: removestoryblips Type: Void Arguments: BlipModel Description: Remove story blip from the list Name: getitemviewtype,getviewtypecount,getcount(),getitem(),getview() Type: - Arguments:None Returns:- Description: Getter Functions Subclasses of BlipFeedAdapter Name: ViewHolder Node: - Description: Container for the view for each row Attributes: None Resources:None None

18 Name: BlipFeedFragment Node: - Description: Generates the List Attributes: int page Resources: Array List Name: OnBlipSelectedListener Type: Interface Description: Allows the fragment to deliver messages from the list to the main activity. Name: oncreateview() Arguments: LayoutInflater inflater,viewgroup container, Bundle savedinstancestate Returns: View Description: This method is called when the view is created and android starts Name: onactivitycreated() Arguments: Bundle savedinstancestate Description: This is what happens when the activity is created Name: onlistitemclick() Type: void Arguments:ListView l, View v, int position, long id Returns: View Description: This is method is called when item on the list is clicked

19 Name: onattach() Type: void Arguments:None Returns: View Description: This makes sure that the container activity has implemented the callback interface Name: cancelsentblips(),removeincomingblips(),removestoryblips() Arguments:None Description:Functions used by getblips to remove all sent Blips Name: getblips() Type: void Arguments:None Description: Connects to the adapter method that removes all Sent Blips To items then adds most update blips Name: MainBlipArray Description: Class holding our array list of BlipModels that is used throughout the app Attributes:None Resources: Array List Name: addblips() Type: void Arguments: BlipModel

20 Description: Add to the array list Name: addblips Type: void Arguments: BlipModel Description: Overloaded method to adapt to BlipManager Name: SmartFragmentStatePagerAdapter Extends:FragmentStatePagerAdapter Description: Stores the MapFragment and the BlipFeed Fragment. Attributes: Fragment Manager Resources: None Name: instantiateitem() Type: Object Arguments: ViewGroup container, int position Returns: Object Type Fragment Description: Registers the fragment when the item is instantiated Name: destroyitem() Type: Void Arguments: ViewGroup container, int position, Object object() Description: Unregister when the item is inactive

21 Name: getregisterfragment() Type: Void Arguments: int position Returns: Fragment Description: Returns the fragment for the position Pre-condition: if instantiated. Name: ViewPagerAdapter Extends:SmartFragmentStatePagerAdapter Node: - Description: In charge of putting the fragments onto the containers Attributes: FragmentManager fm,charsequence mtitles[], int mnumboftabsumb Resources: None Name: getitem() Type: Fragment Arguments:position Returns:Fragment Description: Return the fragment for the every position in the View Pager Name: getpagetitle() Arguments:position Returns: CharSequence Description: Returns the titles for the Tabs in the Tab Strip

22 Name: getcount() Arguments:None Returns: int Description: return the Number of tabs for the tabs Strip LoginAndRegistrations: Name: LoginActivity Node: - Description: AsyncTask used for login of a user Attributes: savedinstancestate Resources: AsyncTask Name: oncreate() Type: void Arguments: Bundle savedinstancestate Description: Sets up login views with event handlers for buttons Name: onclick() Arguments: View Description: Event handler for button clicks Name: AttemptLogin() Extends: AsyncTask Arguments: None

23 Description: Create an asynchronous login for the application. Communicates with the server via the authenticator Pre-condition: Views must be set up. Exceptions: Throws Dialog handler if authenticator throw exception. Name: RegisterActivity Node: - Description: AsyncTask used for registration of a user Attributes: savedinstancestate Resources: AsyncTask Name: oncreate() Type: void Arguments: Bundle savedinstancestate Description: Sets up registration views with event handlers for buttons Name: onclick() Arguments: View Description: Event handler for button clicks Name: AttemptRegister() Extends: AsyncTask Arguments: None Description: Create an asynchronous registration for the application. Communicates with the server via the authenticator. Pre-condition: Views must be set up.

24 Exceptions: Throws Dialog handler if authenticator throw exception. MAP: Name: MapFragment Extends:SmartFragmentStatePagerAdapter Description:? Attributes: int page Resources: Array List, BitMap Name: oncreateview() Arguments: layoutinflater inflater, ViewGroup container, Bundle savedinstancestate Description: Create the Views of the Map Fragment Name: onlocationchanged() Arguments: Location Description: Method callback when the user moves Name: pointcamerato() Arguments: BlipModel Description: Points the map camera to location of the Blip Name: lookatcurrentposition() Arguments: None Description: Look at current position on the map

25 Name: createdrawablefromview() Arguments: Context, View Returns: BitMap Description: Helper function for making custom marker on the map

26 4.DESIGN RATIONALE: DESIGN DECISIONS Decision that effected overall design of System: The client expressed interest from the begin in having the design of the application to be similar to that of Snapchat. They felt that this would provide a smaller learning curve for new users that were already familiar to the popular application Snapchat. This affected our own creative view of the application and restricted us from using design techniques that we were already familiar with. As the client already had an ios version of the project in production most of our design was copied from that. Due to the fact the Client already had a working product ton another platform we were provided with a backend and were not allowed to change any of the existing code which meant we had to conform to the specifications of the backend server.l Dependencies applications has and reasons the for dependencies: Include in our project are external jar that were not in the standard java library: JodaTime : How we managed expiration dates for blips. JUnit : Unit testing. Apache Commons IO: Used to parse input stream into json and strings. TCE security certification for allowing AES keys to be 32 bytes instead of 16 bytes. Android SDK version 21: provides the best compromise adaption due to, 85 percent of android users having support on there phone and providing enough support for implementation of our fragment architecture. Decisions about what was important to do and what was not: As this was a minimal viable project or a start up our emphases was on design and correct functionality. This meant we focused on getting that which was supported on the server working in our application. This meant the product didn't have to be immediately deployed to market and more the foundation for further production. Therefore although functional work cases works really well, however testing of edge cases was not an immediate priority. There were also complications where some methods weren't supported in the server yet meant we weren't apply implement. For next develop: The code has been distributed on Github under a private repository and would be provided on request. The source code along with the Document Plan will serve as a comprehensive design of our implementation. The code will be provided as an android studio application.

27