search

ushahidi / platform

Ushahidi Platform API version 3+
http://ushahidi.com
Other
677 stars 506 forks source link

Setting up a Twitter application is a lengthy process for new users #3533

Closed Erioldoesdesign closed 4 years ago

Erioldoesdesign commented 5 years ago

When setting up Twitter as a data source our first step that we advise users do is to 'Create a new Twitter application'

Screenshot 2019-05-07 at 12 58 28

Recently Twitter has added a lengthy process to be approved for a twitter application and we could offer new users some more advice as to how to get approved and what Twitter needs to approve.

Links to Twitters application documentation would be useful for users. https://developer.twitter.com/en/apps/create

You also must have a twitter account in order to set up an application and even view the docs.

Is your feature request related to a problem? Please describe. Users would be frustrated if they needed to set up twitter feeds into platform within a short period of time. Especially if they are not familiar with this kind of set up.

Describe the solution you'd like A short description on what a twitter application requires e.g. An existing or new Twitter account preferably linked to your project or organisation, a short description of what kind of twitter information you will gather and what you will do with it,

A short text that reads ' Twitter applications may take a few hours or a few days to be approved by Twitter. Please be aware of this if you need this data quickly'

To reproduce/see this section

To Reproduce Steps to reproduce the behavior:

  1. Go to a deployment you have admin access to
  2. Log in as 'an admin'
  3. Click on 'settings'
  4. Scroll down to 'data sources'
  5. Choose 'Twitter' You will see the "Create new twitter application" section/link.

Task: Adding new descriptions to solve this ticket

  1. In the text that says 'Create a new twitter application" add "Twitter applications may take a few hours or a few days to be approved by Twitter. Please be aware of this if you need this data quickly." (note: please feel free to improve on this!) -> this section can be added to the en.json key "intro_step_1_desc" in app/common/locales/en.json within the platform-client repo.

Working on this issue

Implementation notes

Want to work on this issue?🙋

Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

Ping @rowasc if you need help with this issue!

hhold commented 5 years ago

Came across a project called Twint, it doesn't need an API key and can do tweet scraping, just thought I'd share in case it's helpful.

rowasc commented 5 years ago

Hi @hyperhitesh twint is not something we can use at the time. The Twitter ToS prohibits scrapping without explicit consent from Twitter, so we cannot use it. Thanks anyway for the recommendation! :)

Jenniline commented 4 years ago

Hi @rowasc, I will like to be assigned this issue. I need help with this issue. It is quite straight forward and the hint is a lot of help. However, I don't seem to find the line of code from where this issue is from. I have gone through the link on the hint and searched all the code files for the text that says "Create a new Twitter application" but I have not found it. Please direct me on where I can find the text so as that I can work on this issue.

Thanks

Angamanga commented 4 years ago

@Jenniline Thanks for looking into this issue. You find the code for this issue in the datasources-folder: https://github.com/ushahidi/platform-client/tree/develop/app/settings/datasources. What makes it confusing is that the text is coming from the api at this point (https://github.com/ushahidi/platform/blob/develop/src/App/DataSource/Twitter/Twitter.php), so that is why you don't find it :) You could still add the description in the datasource.html-file!

Good luck and reach out if you need more guidance🎉 !

leninpaulino commented 4 years ago

@Jenniline are you currently working on this?

Jenniline commented 4 years ago

Hi @leninpaulino Yes i am currently working on this issue. You can still find more issues on the issue tracker, and keep in mind that Ushahidi has a platform and a platform-client it is good that you set up environment for each because some issues will need you to run the problem and see the behavior before being able to solve. You can reach me if you need help.

Jenniline commented 4 years ago

Hi @leninpaulino Yes I am. Almost done with it

leninpaulino commented 4 years ago

Nice, I'll try to do the setup and after that, I'll move with something else from the issues. Thanks.

Jenniline commented 4 years ago

Alright, you can ping me anytime if you need help.

Jenniline commented 4 years ago

Hi, @Angamanga and @rowasc I have made 2 pull request for this issue. Please review and correct me where necessary

I edited the en.json file as described by @Erioldoesdesign in the problem description. And the Twitter.php file They now display informing new users of the lengthy process of creating a new Twitter application

Do I still need to edit the datasources.html file? Please let me know

Erioldoesdesign commented 4 years ago

Hey @Jenniline I'm gonna comment in the pull request conversation as I have just a few wording tweaks from my perspective of having raised this issue :)

I hope that's okay @Angamanga and @rowasc

Angamanga commented 4 years ago

@Obadha2 Can you test QA this in Steve Buscemi please? Testing checklist:

AmTryingMyBest commented 4 years ago

@Angamanga @Erioldoesdesign @Jenniline could we have this appearing as two different sets of information such that the second part of the text appears as additional information, italicised perhaps. Rather than a long string of text, have something ilke: Step 1: Create a New Twitter application. Twitter applications may take a few hours or days to be approved by Twitter. Please be aware of this if you need this data quickly.

Erioldoesdesign commented 4 years ago

@Obadha2 Makes sense. I would say it should be located after the text link 'new twitter application' that already exists in the layout in italics: Screenshot 2020-02-18 at 14 13 05

Jenniline commented 4 years ago

Ok, I see. @Erioldoesdesign and @Obadha2 will it look better this way?

Step 1: Create a new Twitter application Create a new Twitter application Twitter applications may take a few hours or days to be approved by Twitter. Please be aware of this if you need this data quickly

Is this better?

AmTryingMyBest commented 4 years ago

@Obadha2 Makes sense. I would say it should be located after the text link 'new twitter application' that already exists in the layout in italics: Screenshot 2020-02-18 at 14 13 05

@Erioldoesdesign with that we'd have the text "Create a new Twitter application" appear twice. I suggest we avoid that? Would this appear better?

Step 1: Create a new Twitter application. Twitter applications may take a few hours or days to be approved by Twitter. Please be aware of this if you need this data quickly

Angamanga commented 4 years ago

@Jenniline The change @Obadha2 suggests is good. Do you have time to go ahead and change that?

Jenniline commented 4 years ago

Yes I will @Angamanga Thanks

Jenniline commented 4 years ago

Hi Anna, I Have made the changes requested. Here is the link to the Pull request
https://github.com/ushahidi/platform/pull/3858 I made the changes to the Twitter.php file because that was the file I thought needed the changes you mentioned above and since you had already merged the pull requests to the en.json file. If not please let me know if I should make any more changes to any other files.

Thanks

Angamanga commented 4 years ago

@Obadha2 Could you recheck in Steve Buscemi? The text should now look like this (had to keep the link in the description because of styling-issues. The link did not look ok as a label/headline):

Screenshot 2020-03-02 at 14 31 45
AmTryingMyBest commented 4 years ago

Alright, this looks good @Angamanga ! 👍 Thanks @Jenniline