1. Overview
In the earlier parts of this case study, we set up a simple app and an OAuth authentication process with the Reddit API.
Let's now build something useful with Reddit – support for scheduling Posts for latter.
2. The User and the Post
First, let's create the 2 main entities – the User and the Post. The User will keep track of the username plus some additional Oauth info:
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
@Column(nullable = false)
private String username;
private String accessToken;
private String refreshToken;
private Date tokenExpiration;
private boolean needCaptcha;
// standard setters and getters
}
Next – the Post entity – holding the information necessary for submitting a link to Reddit: title, URL, subreddit, … etc.
@Entity
public class Post {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
@Column(nullable = false) private String title;
@Column(nullable = false) private String subreddit;
@Column(nullable = false) private String url;
private boolean sendReplies;
@Column(nullable = false) private Date submissionDate;
private boolean isSent;
private String submissionResponse;
@ManyToOne
@JoinColumn(name = "user_id", nullable = false)
private User user;
// standard setters and getters
}
3. The Persistence Layer
We're going to use Spring Data JPA for persistence, so there's not a whole lot to look at here, other than the well-known interface definitions for our repositories:
- UserRepository:
public interface UserRepository extends JpaRepository<User, Long> {
User findByUsername(String username);
User findByAccessToken(String token);
}
- PostRepository:
public interface PostRepository extends JpaRepository<Post, Long> {
List<Post> findBySubmissionDateBeforeAndIsSent(Date date, boolean isSent);
List<Post> findByUser(User user);
}
4. A Scheduler
For the scheduling aspects of the app, we're also going to make good use of the out-of-the-box Spring support.
We're defining a task to run every minute; this will simply look for Posts that are due to be submitted to Reddit:
public class ScheduledTasks {
private final Logger logger = LoggerFactory.getLogger(getClass());
private OAuth2RestTemplate redditRestTemplate;
@Autowired
private PostRepository postReopsitory;
@Scheduled(fixedRate = 1 * 60 * 1000)
public void reportCurrentTime() {
List<Post> posts =
postReopsitory.findBySubmissionDateBeforeAndIsSent(new Date(), false);
for (Post post : posts) {
submitPost(post);
}
}
private void submitPost(Post post) {
try {
User user = post.getUser();
DefaultOAuth2AccessToken token =
new DefaultOAuth2AccessToken(user.getAccessToken());
token.setRefreshToken(new DefaultOAuth2RefreshToken((user.getRefreshToken())));
token.setExpiration(user.getTokenExpiration());
redditRestTemplate.getOAuth2ClientContext().setAccessToken(token);
UsernamePasswordAuthenticationToken userAuthToken =
new UsernamePasswordAuthenticationToken(
user.getUsername(), token.getValue(),
Arrays.asList(new SimpleGrantedAuthority("ROLE_USER")));
SecurityContextHolder.getContext().setAuthentication(userAuthToken);
MultiValueMap<String, String> param = new LinkedMultiValueMap<String, String>();
param.add("api_type", "json");
param.add("kind", "link");
param.add("resubmit", "true");
param.add("then", "comments");
param.add("title", post.getTitle());
param.add("sr", post.getSubreddit());
param.add("url", post.getUrl());
if (post.isSendReplies()) {
param.add(RedditApiConstants.SENDREPLIES, "true");
}
JsonNode node = redditRestTemplate.postForObject(
"https://oauth.reddit.com/api/submit", param, JsonNode.class);
JsonNode errorNode = node.get("json").get("errors").get(0);
if (errorNode == null) {
post.setSent(true);
post.setSubmissionResponse("Successfully sent");
postReopsitory.save(post);
} else {
post.setSubmissionResponse(errorNode.toString());
postReopsitory.save(post);
}
} catch (Exception e) {
logger.error("Error occurred", e);
}
}
}
Note that, in case of anything going wrong, the Post will not be marked as sent – so the next cycle will try to submit it again after one minute.
5. The Login Process
With the new User entity, holding some security specific information, we'll need to modify our simple login process to store that information:
@RequestMapping("/login")
public String redditLogin() {
JsonNode node = redditRestTemplate.getForObject(
"https://oauth.reddit.com/api/v1/me", JsonNode.class);
loadAuthentication(node.get("name").asText(), redditRestTemplate.getAccessToken());
return "redirect:home.html";
}
And loadAuthentication():
private void loadAuthentication(String name, OAuth2AccessToken token) {
User user = userReopsitory.findByUsername(name);
if (user == null) {
user = new User();
user.setUsername(name);
}
if (needsCaptcha().equalsIgnoreCase("true")) {
user.setNeedCaptcha(true);
} else {
user.setNeedCaptcha(false);
}
user.setAccessToken(token.getValue());
user.setRefreshToken(token.getRefreshToken().getValue());
user.setTokenExpiration(token.getExpiration());
userReopsitory.save(user);
UsernamePasswordAuthenticationToken auth =
new UsernamePasswordAuthenticationToken(user, token.getValue(),
Arrays.asList(new SimpleGrantedAuthority("ROLE_USER")));
SecurityContextHolder.getContext().setAuthentication(auth);
}
Note how the user is automatically created if it doesn't already exist. This makes the “Login with Reddit” process create a local user in the system on the first login.
6. The Schedule Page
Next – let's take a look at the page that allows scheduling of new Posts:
@RequestMapping("/postSchedule")
public String showSchedulePostForm(Model model) {
boolean isCaptchaNeeded = getCurrentUser().isCaptchaNeeded();
if (isCaptchaNeeded) {
model.addAttribute("msg", "Sorry, You do not have enought karma");
return "submissionResponse";
}
return "schedulePostForm";
}
private User getCurrentUser() {
return (User) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
}
schedulePostForm.html:
<form>
<input name="title" />
<input name="url" />
<input name="subreddit" />
<input type="checkbox" name="sendreplies" value="true"/>
<input name="submissionDate">
<button type="submit" onclick="schedulePost()">Schedule</button>
</form>
<script>
function schedulePost(){
var data = {};
$('form').serializeArray().map(function(x){data[x.name] = x.value;});
$.ajax({
url: 'api/scheduledPosts',
data: JSON.stringify(data),
type: 'POST',
contentType:'application/json',
success: function(result) { window.location.href="scheduledPosts"; },
error: function(error) { alert(error.responseText); }
});
}
</script>
</body>
</html>
Note how we need to check the Captcha. This is because – if the user has less than 10 karma – they can't schedule a post without filling in the Captcha.
7. POSTing
When the Schedule form is submitted, the post info is simply validated and persisted to be picked up by the scheduler later on:
@RequestMapping(value = "/api/scheduledPosts", method = RequestMethod.POST)
@ResponseBody
public Post schedule(@RequestBody Post post) {
if (submissionDate.before(new Date())) {
throw new InvalidDateException("Scheduling Date already passed");
}
post.setUser(getCurrentUser());
post.setSubmissionResponse("Not sent yet");
return postReopsitory.save(post);
}
8. The List of Scheduled Posts
Let's now implement a simple REST API for retrieving the scheduled posts we have:
@RequestMapping(value = "/api/scheduledPosts")
@ResponseBody
public List<Post> getScheduledPosts() {
User user = getCurrentUser();
return postReopsitory.findByUser(user);
}
And a simple, quick way to display these scheduled posts on the front end:
<table>
<thead><tr><th>Post title</th><th>Submission Date</th></tr></thead>
</table>
<script>
$(function(){
$.get("api/scheduledPosts", function(data){
$.each(data, function( index, post ) {
$('.table').append('<tr><td>'+post.title+'</td><td>'+
post.submissionDate+'</td></tr>');
});
});
});
</script>
9. Edit a Scheduled Post
Next – let's see how we can edit a scheduled post.
We'll start with the front-end – first, the very simple MVC operation:
@RequestMapping(value = "/editPost/{id}", method = RequestMethod.GET)
public String showEditPostForm() {
return "editPostForm";
}
After the simple API, here's the front end consuming it:
<form>
<input type="hidden" name="id" />
<input name="title" />
<input name="url" />
<input name="subreddit" />
<input type="checkbox" name="sendReplies" value="true"/>
<input name="submissionDate">
<button type="submit" onclick="editPost()">Save Changes</button>
</form>
<script>
$(function() {
loadPost();
});
function loadPost(){
var arr = window.location.href.split("/");
var id = arr[arr.length-1];
$.get("../api/scheduledPosts/"+id, function (data){
$.each(data, function(key, value) {
$('*[name="'+key+'"]').val(value);
});
});
}
function editPost(){
var id = $("#id").val();
var data = {};
$('form').serializeArray().map(function(x){data[x.name] = x.value;});
$.ajax({
url: "../api/scheduledPosts/"+id,
data: JSON.stringify(data),
type: 'PUT',
contentType:'application/json'
}).done(function() {
window.location.href="../scheduledPosts";
}).fail(function(error) {
alert(error.responseText);
});
}
</script>
Now, let's look at the REST API:
@RequestMapping(value = "/api/scheduledPosts/{id}", method = RequestMethod.GET)
@ResponseBody
public Post getPost(@PathVariable("id") Long id) {
return postReopsitory.findOne(id);
}
@RequestMapping(value = "/api/scheduledPosts/{id}", method = RequestMethod.PUT)
@ResponseStatus(HttpStatus.OK)
public void updatePost(@RequestBody Post post, @PathVariable Long id) {
if (post.getSubmissionDate().before(new Date())) {
throw new InvalidDateException("Scheduling Date already passed");
}
post.setUser(getCurrentUser());
postReopsitory.save(post);
}
10. Unschedule/Delete a Post
We'll also provide a simple delete operation for any of the scheduled Posts:
@RequestMapping(value = "/api/scheduledPosts/{id}", method = RequestMethod.DELETE)
@ResponseStatus(HttpStatus.OK)
public void deletePost(@PathVariable("id") Long id) {
postReopsitory.delete(id);
}
Here's how we call it from client side:
<a href="#" onclick="confirmDelete(${post.getId()})">Delete</a>
<script>
function confirmDelete(id) {
if (confirm("Do you really want to delete this post?") == true) {
deletePost(id);
}
}
function deletePost(id){
$.ajax({
url: 'api/scheduledPosts/'+id,
type: 'DELETE',
success: function(result) {
window.location.href="scheduledPosts"
}
});
}
</script>
11. Conclusion
In this part of our Reddit case-study, we built the first non-trivial bit of functionality using the Reddit API – scheduling Posts.
This is a super-useful feature for a serious Reddit user, especially considering how time-sensitive Reddit submissions are.
Next – we'll build out an even more helpful functionality to help with getting content upvoted on Reddit – machine learning suggestions.
The full implementation of this tutorial can be found in the github project – this is an Eclipse based project, so it should be easy to import and run as it is.