net.jeremybrooks.jinx.api.PandaApi 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.JinxConstants;
import net.jeremybrooks.jinx.JinxException;
import net.jeremybrooks.jinx.JinxUtils;
import net.jeremybrooks.jinx.response.panda.Pandas;
import net.jeremybrooks.jinx.response.photos.Photos;

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

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

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

  /**
   * Return a list of Flickr pandas, from whom you can request photos using the {@link #getPhotos(String, java.util.EnumSet, int, int, boolean)} API method.
   * 

   * This method does not require authentication.
   * 

   * More information about the pandas can be found on the
   * dev blog.
   *
   * @return object with a list of Flickr Pandas, and information about the success or failure of the call.
   * @throws JinxException if there are any errors.
   * @see flickr.panda.getList
   */
  public Pandas getList() throws JinxException {
    Map params = new TreeMap<>();
    params.put("method", "flickr.panda.getList");
    return jinx.flickrGet(params, Pandas.class, false);
  }


  /**
   * Ask the Flickr Pandas for a list of recent public (and "safe") photos.
   * 

   * More information about the pandas can be found on the
   * dev blog.     Authentication
   * 

   * This method does not require authentication.
   * 

   * You can fetch a list of all the current pandas using the {@link #getList()} API method.
   *
   * @param pandaName (Required) The name of the panda to ask for photos from.
   * @param extras    extra information to fetch for each returned record.
   * @param perPage   Number of photos to return per page. If this argument is less than 1, it defaults to 100. The maximum allowed value is 500.
   * @param page      The page of results to return. If this argument is less than 1, it defaults to 1.
   * @param sign      if true, the request will be signed.
   * @return photos object from the panda.
   * @throws Exception if required parameter is missing, or if there are any errors.
   * @see flickr.panda.getPhotos
   */
  public Photos getPhotos(String pandaName, EnumSet extras, int perPage, int page, boolean sign) throws Exception {
    JinxUtils.validateParams(pandaName);
    Map params = new TreeMap<>();
    params.put("method", "flickr.panda.getPhotos");
    params.put("panda_name", pandaName);
    if (!JinxUtils.isNullOrEmpty(extras)) {
      params.put("extras", JinxUtils.buildCommaDelimitedList(extras));
    }
    if (perPage > 0) {
      params.put("per_page", Integer.toString(perPage));
    }
    if (page > 0) {
      params.put("page", Integer.toString(page));
    }
    return jinx.flickrGet(params, Photos.class, sign);
  }
}