Twitter Practice Application - bounswe/bounswe2018group7 GitHub Wiki

In this practice application, we aimed to maintain a hiStory platform living on Twitter. People can write (mini) stories with a nickname (username) to be published on our Twitter account, @hiStory_g7.

You can reach our application on HERE..

• See all the posts (tweets) published on @hiStory_g7.
• See all the posts (tweets) of @hiStory_g7 that contains a URL.
• Create a post (tweet) to be published on @hiStory_g7.
• Search for posts (tweets) of @hiStory_g7 by username (nickname) or tags.

Other than UI, we have created some API endpoints. You can use our API endpoints to interact with the application. UI parts of the application also use these API endpoints internally. API endpoints use Twitter API to interact with Twitter.

They are as follows:

To retrieve all the posts (tweets) published on @hiStory_g7, send a GET request to api/memory_posts/all.json.

Body of the response will be a JSON in the form:

{
  tweet_id: {
              'body' : <full text of the tweet>,
              'created_at' : <time the tweet has been created>
            },
  ...
}

To retrieve all the posts (tweets) of @hiStory_g7 that contains a URL, send a GET request to api/memory_posts/geturl.json.

Body of the response will be a JSON in the form:

[<tweet_text>, <tweet_text>, ...]

To create a post (tweet) on @hiStory_g7, send a POST request to api/memory_posts/create.json. Request body should contain a JSON object in the following form:

{
  'story': <A string of story (tweet text)>,
  'username': <nickname of the writer of the story (author)>,
  'tags': <A List of Strings, each string is a Memory Tag>
}

Only tags field can be omitted. When a request is sent to this API point, a tweet will be created on @hiStory_g7 with this format: <story> AUTHOR: <username> #<tag1> #<tag2> ... #<tagN>

Body of the response will be a JSON in the form:

{
  'result': <A String of either 'success' or 'error'>
  'message': <In case of 'success', a String of posted Tweet. In case of 'error', a String of a specific error message>
}

To search for posts (tweets) published on @hiStory_g7, send a GET request to api/memory_posts/search.json. Request body should contain a JSON in the following form:

{
  'username': <A String of nickname>,
  'tags': <A List of Strings representing tags for memory post.>
}

Only one field (etiher 'username' or 'tags') should be provided.

Body of the response will be a JSON in the form:

{
  tweet_id: {
              'body' : <full text of the tweet>,
              'created_at' : <time the tweet has been created>
            },
  ...
}