module Panoptes
  class Client
    module Projects
      # Fetches the list of all projects.
      #
      # @see http://docs.panoptes.apiary.io/#reference/projects/project-collection/list-all-projects
      # @param search [String] filter projects using full-text search on names (amongst others)
      # @return [Array] the list of projects
      def projects(search: nil)
        params = {}
        params[:search] = search if search

        panoptes.paginate("/projects", params)["projects"]
      end

      # Starts a background process to generate a new CSV export of all the classifications in the project.
      #
      # @param project_id [Integer] the id of the project to export
      # @return [Hash] the medium information where the export will be stored when it's generated
      def create_classifications_export(project_id)
        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
        panoptes.post("/projects/#{project_id}/classifications_export", params)["media"].first
      end

      # Starts a background process to generate a new CSV export of all the subjects in the project.
      #
      # @param project_id [Integer] the id of the project to export
      # @return [Hash] the medium information where the export will be stored when it's generated
      def create_subjects_export(project_id)
        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
        panoptes.post("/projects/#{project_id}/subjects_export", params)["media"].first
      end

      # Starts a background process to generate a new CSV export of all the workflows in the project.
      #
      # @param project_id [Integer] the id of the project to export
      # @return [Hash] the medium information where the export will be stored when it's generated
      def create_workflows_export(project_id)
        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
        panoptes.post("/projects/#{project_id}/workflows_export", params)["media"].first
      end

      # Starts a background process to generate a new CSV export of all the workflow_contents in the project.
      #
      # @param project_id [Integer] the id of the project to export
      # @return [Hash] the medium information where the export will be stored when it's generated
      def create_workflow_contents_export(project_id)
        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
        panoptes.post("/projects/#{project_id}/workflow_contents_export", params)["media"].first
      end

      # Starts a background process to generate a new CSV export of the aggretation results of the project.
      #
      # @param project_id [Integer] the id of the project to export
      # @return [Hash] the medium information where the export will be stored when it's generated
      def create_aggregations_export(project_id)
        params = {media: {content_type: "application/x-gzip", metadata: { recipients: []}}}
        panoptes.post("/projects/#{project_id}/aggregations_export", params)["media"].first
      end
    end
  end
end