net.jeremybrooks.jinx.api.TestApi Maven / Gradle / Ivy

Go to download
/*
 * Jinx is Copyright 2010-2023 by Jeremy Brooks and Contributors
 *
 * Jinx is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Jinx is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Jinx.  If not, see .
 */

package net.jeremybrooks.jinx.api;

import net.jeremybrooks.jinx.Jinx;
import net.jeremybrooks.jinx.JinxException;
import net.jeremybrooks.jinx.response.Response;
import net.jeremybrooks.jinx.response.test.TestEcho;
import net.jeremybrooks.jinx.response.test.TestLogin;

import java.util.Map;
import java.util.TreeMap;

/**
 * Provides access to the flickr.test API methods.
 *
 * @author Jeremy Brooks
 * @see Flickr API documentation for more details.
 */
public class TestApi {
  private Jinx jinx;

  private TestApi() {
  }

  public TestApi(Jinx jinx) {
    this.jinx = jinx;
  }

  /**
   * A testing method which echo's all parameters back in the response.
   *
   * This method does not require authentication.
   *
   * @return object with parameters of the request.
   * @throws JinxException if there are any errors.
   * @see flickr.test.echo
   */
  public TestEcho testEcho() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.test.echo");
    return jinx.flickrGet(params, TestEcho.class, false);
  }

  /**
   * A testing method which checks if the caller is logged in then returns their username.
   * Authentication
   *
   * This method requires authentication with 'read' permission.
   *
   * @return logged in user id and username.
   * @throws JinxException if there are any errors.
   * @see flickr.test.login
   */
  public TestLogin testLogin() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.test.login");
    return jinx.flickrGet(params, TestLogin.class);
  }

  /**
   * Null test
   *
   * This method requires authentication with 'read' permission.
   *
   * @return response object. If successful, the stat parameter will be "ok".
   * @throws JinxException if there are any errors.
   * @see flickr.test.null
   */
  public Response testNull() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.test.null");
    return jinx.flickrGet(params, Response.class);
  }
}