Расписание постов в Reddit с весны
1. обзор
2. User и сообщение
Во-первых, давайте создадим 2 основных объекта -User иPost. User будет отслеживать имя пользователя и некоторую дополнительную информацию Oauth:
@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
}
Далее - объектPost - содержащий информацию, необходимую для отправки ссылки на Reddit:title,URL,subreddit и т. Д.
@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. Слой Постоянства
Мы собираемся использоватьSpring Data JPA for persistence, поэтому здесь особо не на что смотреть, кроме хорошо известных определений интерфейсов для наших репозиториев:
-
UserRepository:
public interface UserRepository extends JpaRepository {
User findByUsername(String username);
User findByAccessToken(String token);
}
-
Пострепозиторий:
public interface PostRepository extends JpaRepository {
List findBySubmissionDateBeforeAndIsSent(Date date, boolean isSent);
List findByUser(User user);
}
4. Планировщик
Для планирования работы приложения мы также собираемся эффективно использовать готовую поддержку Spring.
Мы определяем задачу, которая будет выполняться каждую минуту; это просто будет искатьPosts that are due to be submitted в 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 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 param = new LinkedMultiValueMap();
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);
}
}
}
Обратите внимание: если что-то пойдет не так, сообщение не будет помечено какsent - поэтомуthe next cycle will try to submit it again after one minute.
5. Процесс входа в систему
С новой сущностью User, содержащей некоторую информацию, относящуюся к безопасности, нам нужно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";
}
И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);
}
Обратите внимание, как пользователь создается автоматически, если он еще не существует. Это заставляет процесс «Login with Reddit» создавать локального пользователя в системе при первом входе в систему.
6. Страница расписания
Далее - давайте взглянем на страницу, которая позволяет планировать новые сообщения:
@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:
Обратите внимание, как мы должны проверить капчу. Это потому, что -if the user has less than 10 karma - они не могут запланировать публикацию без заполнения Captcha.
7. оприходование
Когда форма расписания отправлена,the post info is simply validated and persisted будет забран планировщиком позже:
@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. Список запланированных сообщений
Давайте теперь реализуем простой REST API для получения запланированных публикаций:
@RequestMapping(value = "/api/scheduledPosts")
@ResponseBody
public List getScheduledPosts() {
User user = getCurrentUser();
return postReopsitory.findByUser(user);
}
И простой и быстрый способdisplay these scheduled posts on the front end:
Post title Submission Date
9. Редактировать запланированную публикацию
Далее - давайте посмотрим, как мы можем редактировать запланированный пост.
Начнем с внешнего интерфейса - сначала с очень простой операции MVC:
@RequestMapping(value = "/editPost/{id}", method = RequestMethod.GET)
public String showEditPostForm() {
return "editPostForm";
}
После простого API его использует внешний интерфейс:
Теперь посмотрим на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
Мы также предоставим простую операцию удаления для любых запланированных сообщений:
@RequestMapping(value = "/api/scheduledPosts/{id}", method = RequestMethod.DELETE)
@ResponseStatus(HttpStatus.OK)
public void deletePost(@PathVariable("id") Long id) {
postReopsitory.delete(id);
}
Вот как мы это называем со стороны клиента:
11. Заключение
В этой части нашего примера с Reddit мы создали первый нетривиальный бит функциональности с использованием Reddit API - планирование сообщений.
Это очень полезная функция для серьезного пользователя Reddit, особенно с учетомhow time-sensitive Reddit submissions are.
Затем мы создадим еще более полезную функцию, которая поможет получать голоса за контент на Reddit - предложения по машинному обучению.
full implementation этого руководства можно найти вthe github project - это проект на основе Eclipse, поэтому его должно быть легко импортировать и запускать как есть.