jwaterfaucett/bugherd_client

View on GitHub
lib/bugherd_client/resources/v2/attachment.rb

Summary

Maintainability
A
0 mins
Test Coverage
module BugherdClient
  module Resources
    module V2

      class Attachment < Base

        # LIST
        #
        # Get a paginated list of attachments for a task.
        # GET /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments.json
        def all(project_id, task_id)
          raw_response = get_request("projects/#{project_id}/tasks/#{task_id}/attachments")
          parse_response(raw_response, :attachments)
        end

        # SHOW
        #
        # Get detail for specific attachment.
        # GET /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/#{id}.json
        def find(project_id, task_id, attachment_id)
          raw_response = get_request("projects/#{project_id}/tasks/#{task_id}/attachments/#{attachment_id}")
          parse_response(raw_response)
        end

        # CREATE
        #
        # Adds a new attachment to the specified task using an existing URL.
        # POST /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments.json
        #
        # PARAMS
        # {'attachment':{
        #   'file_name':'resolution.gif',
        #   'url':'http://i.imgur.com/U9h3jZI.gif'
        # }}
        def create(project_id, task_id, payload)
          raw_response = post_request("projects/#{project_id}/tasks/#{task_id}/attachments", attachment: payload)
          parse_response(raw_response, :attachment)
        end

        # UPLOAD
        #
        # Upload a new attachment and add it to the specified task.
        # The file contents need to be specified as the POST data on this request.
        #
        # Note that your upload needs to be reasonable in size as the maximum time the request
        # may take is around 30 seconds.
        # If you have larger uploads please create arrange your own file upload
        # and create the attachment from a URL instead.
        #
        # POST /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/upload
        #
        # Note in the sample below please specify an existing file name.
        def upload(project_id, task_id, payload)
          uri = "projects/#{project_id}/tasks/#{task_id}/attachments/upload"
          headers = { content_type: 'application/binary' }
          raw_response = post_request(uri, payload.merge(headers: headers))
          parse_response(raw_response, :attachment)
        end

        # DELETE
        #
        # Delete an attachment from a task. Note that this action is permanent and cannot be undone.
        # DELETE /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/#{id}.json
        def delete(project_id, task_id, attachment_id)
          raw_response = delete_request("projects/#{project_id}/tasks/#{task_id}/attachments/#{attachment_id}")
          parse_response(raw_response)
        end

      end

    end # V2
  end # Resources
end # BugherdClient