Details

    • Type: New Feature
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:

      Description

      App Store enables developers to associate authors with each App. However, the App pages are currently not showing author information.

      At some point, the App Store must have been able to show authors' information. If we visit the Cytoscape App Store, we can see App author information displayed there.

      For example, here is a Cytoscape App page with author info: http://apps.cytoscape.org/apps/enhancedgraphics

      Note how author information is displayed at the end of the page.

      For this task, let's investigate the current "live" Cytoscape App Store code by looking at the "apps" module of their code base.

      See: https://github.com/cytoscape/appstore

        Attachments

        1. apps_app.png
          apps_app.png
          57 kB
        2. apps_author.png
          apps_author.png
          13 kB
        3. apps_orderedauthor.png
          apps_orderedauthor.png
          12 kB
        4. author_app.png
          author_app.png
          101 kB
        5. author_table.png
          author_table.png
          36 kB
        6. authors_page.png
          authors_page.png
          46 kB
        7. Test-Result.png
          Test-Result.png
          41 kB

          Activity

          ann.loraine Ann Loraine created issue -
          ann.loraine Ann Loraine made changes -
          Field Original Value New Value
          Epic Link IGBF-1388 [ 17463 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          Riddhi Jagdish Patil If you are looking for something new to do, here is something that has been waiting for some time to be addressed!

          Show
          ann.loraine Ann Loraine added a comment - Riddhi Jagdish Patil If you are looking for something new to do, here is something that has been waiting for some time to be addressed!
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status Open [ 1 ] To-Do [ 10305 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment -

          Finished displaying author information on the app page and when clicked on the author name, the apps related to the author pops up on the next page.

          To do - CSS indentation needs to be fixed when the short title for apps is not present.

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - Finished displaying author information on the app page and when clicked on the author name, the apps related to the author pops up on the next page. To do - CSS indentation needs to be fixed when the short title for apps is not present.
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment author_app.jpg.png [ 14409 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment authors_page.jpg.png [ 14410 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment author_app.jpg.png [ 14409 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment authors_page.jpg.png [ 14410 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment author_app.png [ 14411 ]
          Attachment authors_page.png [ 14412 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment author_table.png [ 14413 ]
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - - edited

          Issue:
          To add authors' information to the apps and display the list of apps catering to the author when clicked on the author's name

          Solution:
          Allow user to save the author information from app_page_edit. The authors information like the author name and the author institution should be saved in the authors table in database. When a user clicks the author name from the app page, new page containing the list of apps created by that particular author should be displayed.

          Files changed:
          apps/templates/app_page.html
          apps/templates/apps_with_author.html

          Code changes are present in branch-
          https://bitbucket.org/rpatil14/appstore_riddhi/branch/IGBF-2021#diff

          Testing steps:
          Scenario 1:
          1) Click on any app from the available apps.
          2) Click on Editors Action -> Edit this page
          3) Add author name and institution name and click on save
          Refer to author_app.png screenshot

          Scenario 2:
          1) Click on any app from the available apps.
          2) Click on the author name. The page with all the apps related to the author should be displayed
          Refer to authors_page.png screenshot

          Authors information should be saved in database.
          Refer author_table.png

          Table details
          Refer screenshots apps_app.png, apps_author.png, apps_orderedauthor.png for table details
          1) The details of author (author_id, name, institution) are stored in apps_author table
          2) The apps_orderedauthor table has the app_id and the author_id and author_order (i.e. author in which authors are added to the app)

          Testing results:
          Attaching screenshots of local testing to the ticket

          Note: - The code changes are not deployed to devAppStore6 as this server has code changes for IGBF-1992 and requires 1st level review.

          [~aloraine]

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - - edited Issue: To add authors' information to the apps and display the list of apps catering to the author when clicked on the author's name Solution: Allow user to save the author information from app_page_edit. The authors information like the author name and the author institution should be saved in the authors table in database. When a user clicks the author name from the app page, new page containing the list of apps created by that particular author should be displayed. Files changed: apps/templates/app_page.html apps/templates/apps_with_author.html Code changes are present in branch- https://bitbucket.org/rpatil14/appstore_riddhi/branch/IGBF-2021#diff Testing steps: Scenario 1: 1) Click on any app from the available apps. 2) Click on Editors Action -> Edit this page 3) Add author name and institution name and click on save Refer to author_app.png screenshot Scenario 2: 1) Click on any app from the available apps. 2) Click on the author name. The page with all the apps related to the author should be displayed Refer to authors_page.png screenshot Authors information should be saved in database. Refer author_table.png Table details Refer screenshots apps_app.png, apps_author.png, apps_orderedauthor.png for table details 1) The details of author (author_id, name, institution) are stored in apps_author table 2) The apps_orderedauthor table has the app_id and the author_id and author_order (i.e. author in which authors are added to the app) Testing results: Attaching screenshots of local testing to the ticket Note: - The code changes are not deployed to devAppStore6 as this server has code changes for IGBF-1992 and requires 1st level review. [~aloraine]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Attachment apps_app.png [ 14414 ]
          Attachment apps_author.png [ 14415 ]
          Attachment apps_orderedauthor.png [ 14416 ]
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          I like that when user clicks an author's name (on an App page), a new page opens showing App "tiles". I think these tiles should have the same appearance as the tiles we are showing on the home page of the App Store.

          Question: Is that what is happening here?

          If a released App does not yet have a short description, then its "App Tile" should show just a logo of some type and the Bundle-Name parsed from the MANIFEST - nothing else. If the developer has not yet uploaded an App-specific logo, that is fine – in that case, we show the default DNA graphic logo created by Sameer Shanbhag.

          Showing Apps by author is another way to list them, similar to viewing Apps by Category. I think authors will enjoy being able to see a summary of their contributions. For example, they might like sending links to their list of Apps to friends, colleagues, or potential clients/employers.

          Show
          ann.loraine Ann Loraine added a comment - - edited I like that when user clicks an author's name (on an App page), a new page opens showing App "tiles". I think these tiles should have the same appearance as the tiles we are showing on the home page of the App Store. Question : Is that what is happening here? If a released App does not yet have a short description, then its "App Tile" should show just a logo of some type and the Bundle-Name parsed from the MANIFEST - nothing else. If the developer has not yet uploaded an App-specific logo, that is fine – in that case, we show the default DNA graphic logo created by Sameer Shanbhag . Showing Apps by author is another way to list them, similar to viewing Apps by Category. I think authors will enjoy being able to see a summary of their contributions. For example, they might like sending links to their list of Apps to friends, colleagues, or potential clients/employers.
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          ann.loraine Ann Loraine made changes -
          Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          Moved to "Request Change" but actually what I mean is: "Request for clarification" regarding the tile - please see previous comment.

          Show
          ann.loraine Ann Loraine added a comment - Moved to "Request Change" but actually what I mean is: "Request for clarification" regarding the tile - please see previous comment.
          ann.loraine Ann Loraine made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          Hide
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment -

          I am using same code app_button.html which is used to display apps on home page to display the App "titles" related to author. When you hover on the app titles, the tool tip with Bundle_Name will be displayed and box-highlight appears around the app. This behavior is same as the home page app behavior.
          Also, if the short title is not present then its "App Tile" will show just a logo of some type and the Bundle-Name.

          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - I am using same code app_button.html which is used to display apps on home page to display the App "titles" related to author. When you hover on the app titles, the tool tip with Bundle_Name will be displayed and box-highlight appears around the app. This behavior is same as the home page app behavior. Also, if the short title is not present then its "App Tile" will show just a logo of some type and the Bundle-Name.
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          Thanks! Please proceed with next step.

          Show
          ann.loraine Ann Loraine added a comment - Thanks! Please proceed with next step.
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          ann.loraine Ann Loraine made changes -
          Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
          ann.loraine Ann Loraine made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          Show
          rpatil14 Riddhi Jagdish Patil (Inactive) added a comment - Pull request submitted: https://bitbucket.org/lorainelab/appstore/pull-requests/120/igbf-2021-display-author-information-on/diff
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Assignee Riddhi Jagdish Patil [ rpatil14 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          Merged to master, ready for testing.

          Show
          ann.loraine Ann Loraine added a comment - Merged to master, ready for testing.
          ann.loraine Ann Loraine made changes -
          Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
          ann.loraine Ann Loraine made changes -
          Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
          sameer Sameer Shanbhag (Inactive) made changes -
          Assignee Sameer Shanbhag [ sameer ]
          sameer Sameer Shanbhag (Inactive) made changes -
          Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
          Hide
          sameer Sameer Shanbhag (Inactive) added a comment - - edited

          Functionality Works as Expected. Deployed on dev-appstore-1.bioviz.org

          I have a doubt here:
          1. I can have multiple authors with the same name and there is no primary key constraint.
          2. There should be some primary_key when you store the author as the author-name can be misspelled and there is no way of identifying what went wrong.
          3. Example:
          If "Sameer" with Institution Name "UNCC" is an author of App1 and "Sameer" with Institution Name say "UN" is the author of the App2 when I click on either of the Sameer it gives me multiple results for the same app which should not be the case.

          Example reproduced at the deployed AppStore.

          The current feature is working as expected, but I think there should be some way for us to identify exactly particular author from multiple authors of the same name.

          Prof. [~aloraine] can you please review this scenario. Thanks.

          Show
          sameer Sameer Shanbhag (Inactive) added a comment - - edited Functionality Works as Expected. Deployed on dev-appstore-1.bioviz.org I have a doubt here: 1. I can have multiple authors with the same name and there is no primary key constraint. 2. There should be some primary_key when you store the author as the author-name can be misspelled and there is no way of identifying what went wrong. 3. Example: If "Sameer" with Institution Name "UNCC" is an author of App1 and "Sameer" with Institution Name say "UN" is the author of the App2 when I click on either of the Sameer it gives me multiple results for the same app which should not be the case. Example reproduced at the deployed AppStore. The current feature is working as expected, but I think there should be some way for us to identify exactly particular author from multiple authors of the same name. Prof. [~aloraine] can you please review this scenario. Thanks.
          sameer Sameer Shanbhag (Inactive) made changes -
          Resolution Incomplete [ 4 ]
          Attachment Test-Result.png [ 14428 ]
          Hide
          sameer Sameer Shanbhag (Inactive) added a comment -

          Test Result attached as Test-Result.png

          Show
          sameer Sameer Shanbhag (Inactive) added a comment - Test Result attached as Test-Result.png
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          Before I weigh in on this: I have 2 questions about how we are tracking authors:

          • Are we also capturing the user (login validated thru social auth) that submitted the App?
          • How are we enabling editors for same?

          Also, please post a quick link to the models.py file that contains the definition of the Author class.

          Thanks for catching this!

          Sameer Shanbhag

          Show
          ann.loraine Ann Loraine added a comment - - edited Before I weigh in on this: I have 2 questions about how we are tracking authors: Are we also capturing the user (login validated thru social auth) that submitted the App? How are we enabling editors for same? Also, please post a quick link to the models.py file that contains the definition of the Author class. Thanks for catching this! Sameer Shanbhag
          Hide
          sameer Sameer Shanbhag (Inactive) added a comment -

          We have the user info for a particular session but that is not linked to the Authors.
          Authors are completely different Feature all-together.
          Editors are different as well. (Editors are specified by the email addresses)

          Model.py for Authors can be found here:
          apps/models.py

          Requirements (Currently):
          Editors ->
          1. Need to be a user on the website.
          2. Can add editors to an app using their Email only
          3. Editors have nothing to do with Authors

          Authors:
          1. Just add a name and institution
          2. Does not need to be a part of our website
          3. Can enter a random string like "abcd" and it will still take it as an author.

          We need to add a feature to track author name somehow or store an author detail somehow and link all the Apps related to the author to that one Author.

          Show
          sameer Sameer Shanbhag (Inactive) added a comment - We have the user info for a particular session but that is not linked to the Authors. Authors are completely different Feature all-together. Editors are different as well. (Editors are specified by the email addresses) Model.py for Authors can be found here: apps/models.py Requirements (Currently): Editors -> 1. Need to be a user on the website. 2. Can add editors to an app using their Email only 3. Editors have nothing to do with Authors Authors: 1. Just add a name and institution 2. Does not need to be a part of our website 3. Can enter a random string like "abcd" and it will still take it as an author. We need to add a feature to track author name somehow or store an author detail somehow and link all the Apps related to the author to that one Author.
          ann.loraine Ann Loraine made changes -
          Sprint Fall 2019 Sprint 3 [ 74 ] Fall 2019 Sprint 3, Fall 2019 Sprint 4 [ 74, 75 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          Hide
          sameer Sameer Shanbhag (Inactive) added a comment -

          Moving this to complete and let's create a new task for improving author Functionality.

          Show
          sameer Sameer Shanbhag (Inactive) added a comment - Moving this to complete and let's create a new task for improving author Functionality.
          sameer Sameer Shanbhag (Inactive) made changes -
          Resolution Incomplete [ 4 ] Done [ 10000 ]
          Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
          sameer Sameer Shanbhag (Inactive) made changes -
          Assignee Sameer Shanbhag [ sameer ] Riddhi Jagdish Patil [ rpatil14 ]
          ann.loraine Ann Loraine made changes -
          Workflow Fall 2019 Workflow Update [ 20778 ] Revised Fall 2019 Workflow Update [ 22518 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Link This issue relates to IGBF-2087 [ IGBF-2087 ]
          rpatil14 Riddhi Jagdish Patil (Inactive) made changes -
          Link This issue relates to IGBF-2087 [ IGBF-2087 ]

            People

            • Assignee:
              rpatil14 Riddhi Jagdish Patil (Inactive)
              Reporter:
              ann.loraine Ann Loraine
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: