module KineticSdk
  class Core

    # Add a Datastore Submission
    #
    # @param form_slug [String] slug of the Form
    # @param payload [Hash] payload of the submission
    #   - +origin+ - Origin ID of the submission to be added
    #   - +parent+ - Parent ID of the submission to be added
    #   - +values+ - hash of field values for the submission
    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def add_datastore_submission(form_slug, payload={}, headers=default_headers)
      # set origin hash if origin was passed as a string
      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
      # set parent hash if parent was passed as a string
      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
      # prepare any attachment values
      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
      # Create the submission
      @logger.info("Adding a submission in the \"#{form_slug}\" Datastore Form.")
      post("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
    end

    # Add a Datastore Submission page
    #
    # @param form_slug [String] slug of the Form
    # @param page_name [String] name of the Page
    # @param payload [Hash] payload of the submission
    #   - +origin+ - Origin ID of the submission to be added
    #   - +parent+ - Parent ID of the submission to be added
    #   - +values+ - hash of field values for the submission
    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def add_datastore_submission_page(form_slug, page_name, payload={}, headers=default_headers)
      # set origin hash if origin was passed as a string
      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
      # set parent hash if parent was passed as a string
      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
      # prepare any attachment values
      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
      # Create the submission
      @logger.info("Adding a submission page in the \"#{form_slug}\" Datastore Form.")
      post("#{@api_url}/datastore/forms/#{form_slug}/submissions?page=#{encode(page_name)}", payload, headers)
    end

    # Patch a new Datastore Submission
    #
    # @param form_slug [String] slug of the Form
    # @param payload [Hash] payload of the submission
    #   - +origin+ - Origin ID of the submission to be patched
    #   - +parent+ - Parent ID of the submission to be patched
    #   - +values+ - hash of field values for the submission
    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def patch_datastore_submission(form_slug, payload={}, headers=default_headers)
      # set the currentPage hash if currentPage was passed as a string
      payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
      # set origin hash if origin was passed as a string
      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
      # set parent hash if parent was passed as a string
      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
      # prepare any attachment values
      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
      # Create the submission
      @logger.info("Patching a submission in the \"#{form_slug}\" Form.")
      patch("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
    end

    # Patch an existing Datastore Submission
    #
    # @param submission_id [String] id of the Submission
    # @param payload [Hash] payload of the submission
    #   - +origin+ - Origin ID of the submission to be patched
    #   - +parent+ - Parent ID of the submission to be patched
    #   - +values+ - hash of field values for the submission
    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def patch_existing_datastore_submission(submission_id, payload={}, headers=default_headers)
      # set the currentPage hash if currentPage was passed as a string
      payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
      # set origin hash if origin was passed as a string
      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
      # set parent hash if parent was passed as a string
      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
      # prepare any attachment values
      payload["values"] = prepare_updated_datastore_submission_values(submission_id, payload["values"])
      # Update the submission
      @logger.info("Patching a submission with id \"#{submission_id}\"")
      patch("#{@api_url}/datastore/submissions/#{submission_id}", payload, headers)
    end

    # Find all Submissions for a Datastore Form.
    #
    # This method will process pages of form submissions and internally
    # concatenate the results into a single array.
    #
    # Warning - using this method can cause out of memory errors on large
    #           result sets.
    #
    # @param form_slug [String] slug of the Form
    # @param params [Hash] Query parameters that are added to the URL, such as +include+
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def find_all_form_datastore_submissions(form_slug, params={}, headers=default_headers)
      @logger.info("Finding submissions for the \"#{form_slug}\" Datastore Form.")
      # Make the initial request of pages submissions
      response = find_form_datastore_submissions(form_slug, params, headers)
      # Build the Messages Array
      messages = response.content["messages"]
      # Build Submissions Array
      submissions = response.content["submissions"]
      # if a next page token exists, keep retrieving submissions and add them to the results
      while (!response.content["nextPageToken"].nil?)
        params['pageToken'] = response.content["nextPageToken"]
        response = find_form_datastore_submissions(form_slug, params, headers)
        # concat the messages
        messages.concat(response.content["messages"] || [])
        # concat the submissions
        submissions.concat(response.content["submissions"] || [])
      end
      final_content = { "messages" => messages, "submissions" => submissions, "nextPageToken" => nil }
      # Return the results
      response.content=final_content
      response.content_string=final_content.to_json
      response
    end

    # Find a page of Submissions for a Datastore form.
    #
    # The page offset can be defined by passing in the "pageToken" parameter,
    # indicating the value of the token that will represent the first
    # submission in the result set.  If not provided, the first page of
    # submissions will be retrieved.
    #
    # @param form_slug [String] slug of the Form
    # @param params [Hash] Query parameters that are added to the URL, such as +include+
    #   - +pageToken+ - used for paginated results
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def find_form_datastore_submissions(form_slug, params={}, headers=default_headers)
      # Get next page token
      token = params["pageToken"]
      if token.nil?
        @logger.info("Finding first page of submissions for the \"#{form_slug}\" Datastore.")
      else
        @logger.info("Finding page of submissions starting with token \"#{token}\" for the \"#{form_slug}\" Form.")
      end

      # Build Submission URL
      url = "#{@api_url}/datastore/forms/#{form_slug}/submissions"
      # Return the response
      get(url, params, headers)
    end

    # Find a Datastore submission
    #
    # @param submission_id [String] String value of the Submission Id (UUID)
    # @param params [Hash] Query parameters that are added to the URL, such as +include+
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def find_datastore_submission(submission_id, params={}, headers=default_headers)
      @logger.info("Finding Datastore Submission \"#{submission_id}\"")
      get("#{@api_url}/datastore/submissions/#{encode(submission_id)}", params, headers)
    end


    # Update a Datastore submission
    #
    # @param submission_id [String] String value of the Submission Id (UUID)
    # @param body [Hash] submission properties to update
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def update_datastore_submission(submission_id, body={}, headers=default_headers)
      @logger.info("Updating Datastore Submission \"#{submission_id}\"")
      put("#{@api_url}/datastore/submissions/#{encode(submission_id)}", body, headers)
    end


    # Delete a Datastore submission
    #
    # @param submission_id [String] String value of the Submission Id (UUID)
    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
    def delete_datastore_submission(submission_id, headers=default_headers)
      @logger.info("Deleting Datastore Submission \"#{submission_id}\"")
      delete("#{@api_url}/datastore/submissions/#{encode(submission_id)}", headers)
    end

    private

    # Prepares new datastore submission values for attachment fields
    #
    # @param form_slug [String] datastore form slug
    # @param values [Hash] hash of values being submitted
    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
    def prepare_new_datastore_submission_values(form_slug, values)
      file_upload_url = "#{@api_url.gsub('/api/v1','')}/datastore/forms/#{form_slug}/files"
      prepare_submission_values(values, file_upload_url)
    end

    # Prepares updated datastore submission values for attachment fields
    #
    # @param submission_id [String] id of the Submission
    # @param values [Hash] hash of values being submitted
    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
    def prepare_updated_datastore_submission_values(submission_id, values)
      file_upload_url = "#{@api_url.gsub('/api/v1','')}/datastore/submissions/#{submission_id}/files"
      prepare_submission_values(values, file_upload_url)
    end

  end
end