Skip to content

Latest commit

 

History

History
93 lines (74 loc) · 2.73 KB

README.md

File metadata and controls

93 lines (74 loc) · 2.73 KB

File Bundle

This bundle contains an upload service for binary files.

Extended documentation can be found here

Configuration

Due to the dependency on gaufrette\file at least one adapter and the filesystems.file_service has to be configured in config.yml:

knp_gaufrette:
    adapters:
        local:
            local:
                directory: '%kernel.root_dir%/files'
                create: true
        s3:
            aws_s3:
                service_id: 'graviton.aws_s3.client'
                bucket_name: '%graviton.aws_s3.bucket_name%'
                options:
                    create: true
    filesystems:
        file_service:
            adapter: %graviton.file.gaufrette.backend%

There is further the option to configure the access to the Amazone Webservices S3 for file storage. Use the following configuration parameters to do so:

    graviton.file.backend: (local|s3)
    graviton.file.s3.endpoint: (the S3 access host)
    graviton.file.s3.key: (the S3 client key)
    graviton.file.s3.secret: (the S3 preshared secret)
    graviton.file.s3.bucket_name: (the location of the files on S3. Usually: graviton-dev-bucket)

NOTICE In case an environment variable named VCAP_SERVICES is available every configuration option accessible via parameter.yml will be replaced by the settings provided by VCAP_SERVICES.

Usage

Creating a new file

curl -X POST \
     -H 'Content-Type: text/plain' \
     -d "Hello World!" \
     http://localhost/file

Adding metadata to the file

curl -X PUT \
     -H 'Content-Type: application/json' \
     -d '{"id": "<id>", "links": [{"$ref": "http://localhost/core/app/tablet"}]}' \
     http://localhost/file/<id>

Retrieving the file

curl -X PUT \
     -H 'Accept: text/plain' \
     http://localhost/file/<id>

Creating a new file and sending meta data in one request

Since this is basically a form submit the information is send as form fields:

  • metadata » use for the metadata formerly sent as payload in step 2
  • upload » use to send the file to be stored
curl -X POST \
     -F 'metadata={"action":[{"command":"print"}]}' \
     -F [email protected] \
     http://localhost/file

In addition to the POST method, multipart/form-data was implemented for the PUT method as well. In order to update a file and its' metadata simultaneously, one needs to GET the file meta information first by sending a request with the Accept: application/json header added.

curl -X PUT \
    -F 'metadata={"id": "myPersonalFile","links":[],"metadata":{"action":[{"command":"print"}]}}' \
    -F [email protected] \ 
    http://example.org/file/myPersonalFile