Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

iframe page for embedding in 3rd party websites #283

Open
mattsayre opened this issue Feb 2, 2022 · 27 comments
Open

iframe page for embedding in 3rd party websites #283

mattsayre opened this issue Feb 2, 2022 · 27 comments
Assignees
Labels
enhancement New feature or request

Comments

@mattsayre
Copy link
Collaborator

mattsayre commented Feb 2, 2022

Is your feature request related to a problem? Please describe.
Looking to enable 3rd party branded websites to embed a speedup page, in their website. This will be a survey style form, very similar to how it is done on speedupamerica.com proper, meaning a sequence for taking a speed test of geolocation (use my browsers location/use my addres), then Residential/Mobile/Public, connection tyep (wired/wireless/etc), price, advertised speed. Then return speed results and comparison.

Describe the solution you'd like
iframe so that it can be branded by third parties. Only branding inside the frame will be "Powered by SpeedUpAmerica"

Describe alternatives you've considered
Javascript embed

Additional context
Don't need mapping, this feature is simply for collecting crowdsourced speed test results.

Regional Report Link: https://speedupamerica.com/region_submissions/region_export_csv_report/
(added for future reference - @webaissance )

@mattsayre mattsayre added the enhancement New feature or request label Feb 2, 2022
@webaissance
Copy link
Collaborator

I am working on this. Didn't see how to assign to myself.

@webaissance webaissance self-assigned this Feb 6, 2022
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Mar 23, 2022
* Adds new routes in routes.rb
  get 'region/*regionname', to: 'region#index'
  get 'region-results', to: 'regionsubmissions#result_page', as: :regionresult_page
  get 'regionresult/:test_id', to: 'regionsubmissions#show', as: :regionsubmission

* Adds new route page with the following folders
  /app/views/region
  /app/views/regionshared
  /app/views/regionsubmissions

* Adds animated images for regions (not visible yet)
  /app/assets/images/take_the_test-animated3.gif
  /app/assets/images/view_results-animated3.gif

* Usage
  <iframe src="https://speedupamerica.com/region/Oregon" width="1000" height="500"></iframe>
  <iframe src="https://speedupamerica.com/region/New%20York" width="1000" height="500"></iframe>
  <iframe src="https://speedupamerica.com/region/Quebec" width="1000" height="500"></iframe>
  <iframe src="https://speedupamerica.com/region/Mexico" width="1000" height="500"></iframe>
webaissance added a commit that referenced this issue Mar 23, 2022
#283 iframe page for embedding in 3rd party websites
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 4, 2022
* Update form steps
* Break out assets to not interfere with main site test
* Add styling and functionality for theming regions
* Duplicate speed tests for regions
webaissance added a commit that referenced this issue Apr 11, 2022
#283 Add functionality for Regional iFrame site
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 19, 2022
mattsayre added a commit that referenced this issue Apr 19, 2022
#283 Allow Uppercase or lowercase for Oregon, Washington or Californi…
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 20, 2022
* Data now inputting to new tables
* Show results page
* Export data
* Updates to styles
webaissance added a commit that referenced this issue Apr 20, 2022
#283 iframe page for embedding in 3rd party websites
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 21, 2022
…tinued

* Remark out region_submission.populate_boundaries which was causing an error - hope this will fix the issue
webaissance added a commit that referenced this issue Apr 21, 2022
#283 iframe page for embedding in 3rd party websites - continued
@mattsayre
Copy link
Collaborator Author

@webaissance a few copy and other minor edits:

  1. Remove the copy "Test Your Internet Speed Oregon"
  2. Remove the copy "In 5 Steps"
  3. Remove the question about connection type (wired/wifi/cellular) in its entirety.
  4. Change Estimated price per month question to OPTIONAL.
  5. Remove csv Export button from iframe, just need to know the direct link URL.

@webaissance
Copy link
Collaborator

Okay @mattsayre - I will work on those - give me till tomorrow mid-morning and I'll send these updates through.

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 22, 2022
* Remove the copy "Test Your Internet Speed Oregon"
* Remove the copy "In 5 Steps"
* Remove csv Export button from iframe, just need to know the direct link URL.
mattsayre added a commit that referenced this issue Apr 22, 2022
#283 iframe page for embedding in 3rd party websites
@mattsayre
Copy link
Collaborator Author

Additional minor edits @webaissance :

  1. Make question 3 (regarding price), optional. This will require the additional change of having question 4 come up to fill out in tandem with question 3.
  2. The "i" hover over in question 3 floats up and is getting cut off (readability). Needs to float down, which should prevent the text from being cutoff.
  3. Remove entire statement on results page, "This test helps...".

@mattsayre
Copy link
Collaborator Author

Additional minor edit @webaissance

  1. we need to change the language under the "I don't have internet" track, when they enter their address. The copy should be replaced with "I'd like to register my address as a location that doesn't have internet".

@webaissance
Copy link
Collaborator

webaissance commented Apr 27, 2022 via email

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 27, 2022
* Remove the question about connection type (wired/wifi/cellular) in its entirety.
* Change Estimated price per month question to OPTIONAL.
* Remove csv Export button from iframe, just need to know the direct link URL.
* Make question 3 (regarding price), optional. This will require the additional change of having question 4 come up to fill out in tandem with question 3.
* The "i" hover over in question 3 floats up and is getting cut off (readability). Needs to float down, which should prevent the text from being cutoff.
* Remove entire statement on results page, "This test helps...".
* we need to change the language under the "I don't have internet" track, when they enter their address. The copy should be replaced with "I'd like to register my address as a location that doesn't have internet".
@webaissance
Copy link
Collaborator

webaissance commented Apr 27, 2022 via email

mattsayre added a commit that referenced this issue Apr 27, 2022
iframe page for embedding in 3rd party websites #283
@mattsayre
Copy link
Collaborator Author

mattsayre commented Apr 28, 2022

@webaissance three additional minor edits:

  1. Add second required checkbox on question 1 (have/have not internet). This will replace the passive agreement and associated language which is currently "By entering your information you agree to the data policy." NEW language next to new checkbox "I agree to the data policy https://www.measurementlab.net/privacy/ and have read the disclaimer <disclaimer site https://test.fasterinternetoregon.org/disclaimer/)>.

  2. Remove entirely the price I would pay question, under the click path for "i don't have internet".

  3. Remove the informational "i" in "What is the estimated price..." question, under the click path of "I have internet access at my home".

@webaissance
Copy link
Collaborator

@mattsayre I am working on these. I would say anything that's just cosmetic or type change is minor. Anything that changes functionality is small but not minor - because it changes the logic and has the potential to break things and therefore requires more thorough testing. In any case - I will try to get these done asap and send through a PR.

@webaissance
Copy link
Collaborator

For 1) - the new Opt-in item - we should probably add this as a database field - for opt-in right? This would involve running the db migrator update again.
For now I will not do that - since this appears to be urgent - but can add it later if needed.

@webaissance
Copy link
Collaborator

Related to this - wouldn't each region have it's own disclaimer - so the link shouldn't be hardcoded in - but a configuration for each region?

@mattsayre
Copy link
Collaborator Author

mattsayre commented Apr 29, 2022 via email

@mattsayre
Copy link
Collaborator Author

mattsayre commented Apr 29, 2022 via email

@webaissance
Copy link
Collaborator

webaissance commented Apr 29, 2022

Okay. And also - the disclaimer link is being hardcoded to the test instance: https://test.fasterinternetoregon.org/disclaimer/
It should go to the live instance - but that's not live yet...
In any case - I have added a place in the controller to set different disclaimer links for different regions.
PR coming up shortly...

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue Apr 29, 2022
*Add second required checkbox on question 1 (have/have not internet). This will replace the passive agreement and associated language which is currently "By entering your information you agree to the data policy." NEW language next to new checkbox "I agree to the data policy https://www.measurementlab.net/privacy/ and have read the disclaimer <disclaimer site https://test.fasterinternetoregon.org/disclaimer/)>.

*Remove entirely the price I would pay question, under the click path for "i don't have internet".

*Remove the informational "i" in "What is the estimated price..." question, under the click path of "I have internet access at my home".
mattsayre added a commit that referenced this issue Apr 29, 2022
iframe page for embedding in 3rd party websites #283
@mattsayre
Copy link
Collaborator Author

@webaissance follow-up to our conversation about restoring IP address lookup capability for naming ISP's.

@mattsayre
Copy link
Collaborator Author

@webaissance add Spanish language version of iframe. Copy attached
iframe language for translation FIO-es-US.docx
Of note, Internationalization in Rails: https://guides.rubyonrails.org/i18n.html
Also of note, need to link out to the host website and their spanish language translation version of the Disclaimber.

.

@mattsayre
Copy link
Collaborator Author

Link to (test) Spanish translation of disclaimer https://test.fasterinternetoregon.org/es/disclaimer/

@mattsayre
Copy link
Collaborator Author

@webaissance - BUG - Scenario where user clicks “I do NOT have internet…”, then “Internet is not affordable”, then register my address… it currently initiates a speed test. There should NOT be a speed test initiated in this flow.

@webaissance
Copy link
Collaborator

webaissance commented May 6, 2022 via email

@mattsayre
Copy link
Collaborator Author

When user selects "I do NOT have Internet access..." > Internet is not affordable, they should receive this confirmation message (and not initiate the speed test):

"Thank you for your participation. Get more information on state and federal government discounted Internet access programs: https://www.oregon.gov/puc/pages/oregon-lifeline.aspx”

"Gracias por su participación. Obtenga más información sobre programas del gobierno estatal y federal que ofrecen acceso a Internet con descuento: https://www.oregon.gov/puc/pages/oregon-lifeline.aspx”

When user selects "I do NOT have Internet access..." > Internet is not available..., they receive this confirmation message:

"Thank you for your participation."
"Gracias por su participación.”

@webaissance
Copy link
Collaborator

@mattsayre - I'm not clear on the process flow for different scenarios - particularly if no internet connection.
If no internet - do we still want to collect data - or just do nothing?
What about the "register this address as having no internet" option from before?

It would nice to have a flowchart of the scenarios.
Here are 2 flowcharts I made. I'm trying to understand if you want scenario A or B - or something else?

SpeedUp-FlowChartA-2022-05-08.pdf

SpeedUp-FlowChartB-2022-05-08.pdf

@mattsayre
Copy link
Collaborator Author

@webaissance yes, we do want to collect data from all form submissions (have and have not internet). Flow chart B is very close, made one edit, see attached
flow B version 2

.

@webaissance
Copy link
Collaborator

Thanks @mattsayre - now I'm getting clarity. I made an updated flowchart on SmartDraw.com. It allows us to collaborate on Flowcharts via shared links,
So you can go in and make edits here as needed -

FlowChartC-2022-05-09.pdf

I think if we collaborate on flow charts like this it will really help provide clarity and accuracy to the project and we can accelerate our progress.

I'm evaluating SmartDraw.com - and also looking at Lucid.co and will evaluate others. If we can leverage some of these amazing tools it will really help!

I will be sending a Pull Request that matches this flowchart as soon as I can.

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue May 9, 2022
* add Spanish language version of iframe
* Began fix to "BUG - Scenario where user clicks “I do NOT have internet…”, then “Internet is not affordable”, then register my address… it currently initiates a speed test. There should NOT be a speed test initiated in this flow."
Submit button doesn't work quite yet - but it doesn't run the speed test and shows the submit button instead. I will hook the button up to the submital functionality next

Use https://test.speedupamerica.com/region/Oregon-es or https://test.speedupamerica.com/region/oregon-es to see the Spanish version
mattsayre added a commit that referenced this issue May 9, 2022
iframe page for embedding in 3rd party websites #283
@mattsayre
Copy link
Collaborator Author

@webaissance additional translation:

Your Results = Sus Resultados

Download Speed = Velocidad de Descarga

Upload Speed = Velocidad de Carga

Ping = Ping

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue May 10, 2022
* Scenario where no internet does not run speed test. Instead submits data to database
* 3 possible messages: a) Speed Results b) No internet - not affordable  c) No internet - no access
mattsayre added a commit that referenced this issue May 11, 2022
iframe page for embedding in 3rd party websites #283
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue May 14, 2022
* Change region disclaimer links to Live instead of Test
  ** https://www.fasterinternetoregon.org/es/disclaimer/
  ** https://www.fasterinternetoregon.org/disclaimer/
* Added Provider field to output of Region test and Region CSV export
  (locally this field is showing up blank. I hope it will get data on the test and live sites)
* Added direct path to retrieve Region CSV export: https://speedupamerica.com/region_submissions/region_export_csv_report/
mattsayre added a commit that referenced this issue May 14, 2022
iframe page for embedding in 3rd party websites #283
@mattsayre
Copy link
Collaborator Author

@webaissance while we work to figure why the 'provider' lookup is not working, let's add IP Address to the csv export, so that it can be derived later in the overall workflow (in the separate analysis tool).

@mattsayre
Copy link
Collaborator Author

@webaissance in the CSV export, the significant digits for lat/long appear to be truncating or rounding. Let's work together to ensure that those get read out fully.

@webaissance
Copy link
Collaborator

webaissance commented May 20, 2022 via email

webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue May 20, 2022
* Add IP Address to regional export
webaissance pushed a commit to webaissance/SpeedUpAmerica that referenced this issue May 23, 2022
* Remove 2 fields from CSV export: accurracy and connected_with
mattsayre added a commit that referenced this issue May 23, 2022
iframe page for embedding in 3rd party websites #283
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants